1 /*
2  * Copyright 2015 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 #include <algorithm>
18 
19 #include <grallocusage/GrallocUsageConversion.h>
20 #include <log/log.h>
21 #include <ui/BufferQueueDefs.h>
22 #include <sync/sync.h>
23 #include <utils/StrongPointer.h>
24 #include <utils/Vector.h>
25 #include <system/window.h>
26 #include <android/hardware/graphics/common/1.0/types.h>
27 
28 #include "driver.h"
29 
30 using android::hardware::graphics::common::V1_0::BufferUsage;
31 
32 // TODO(jessehall): Currently we don't have a good error code for when a native
33 // window operation fails. Just returning INITIALIZATION_FAILED for now. Later
34 // versions (post SDK 0.9) of the API/extension have a better error code.
35 // When updating to that version, audit all error returns.
36 namespace vulkan {
37 namespace driver {
38 
39 namespace {
40 
41 const VkSurfaceTransformFlagsKHR kSupportedTransforms =
42     VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR |
43     VK_SURFACE_TRANSFORM_ROTATE_90_BIT_KHR |
44     VK_SURFACE_TRANSFORM_ROTATE_180_BIT_KHR |
45     VK_SURFACE_TRANSFORM_ROTATE_270_BIT_KHR |
46     // TODO(jessehall): See TODO in TranslateNativeToVulkanTransform.
47     // VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR |
48     // VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR |
49     // VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR |
50     // VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR |
51     VK_SURFACE_TRANSFORM_INHERIT_BIT_KHR;
52 
TranslateNativeToVulkanTransform(int native)53 VkSurfaceTransformFlagBitsKHR TranslateNativeToVulkanTransform(int native) {
54     // Native and Vulkan transforms are isomorphic, but are represented
55     // differently. Vulkan transforms are built up of an optional horizontal
56     // mirror, followed by a clockwise 0/90/180/270-degree rotation. Native
57     // transforms are built up from a horizontal flip, vertical flip, and
58     // 90-degree rotation, all optional but always in that order.
59 
60     // TODO(jessehall): For now, only support pure rotations, not
61     // flip or flip-and-rotate, until I have more time to test them and build
62     // sample code. As far as I know we never actually use anything besides
63     // pure rotations anyway.
64 
65     switch (native) {
66         case 0:  // 0x0
67             return VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
68         // case NATIVE_WINDOW_TRANSFORM_FLIP_H:  // 0x1
69         //     return VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR;
70         // case NATIVE_WINDOW_TRANSFORM_FLIP_V:  // 0x2
71         //     return VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR;
72         case NATIVE_WINDOW_TRANSFORM_ROT_180:  // FLIP_H | FLIP_V
73             return VK_SURFACE_TRANSFORM_ROTATE_180_BIT_KHR;
74         case NATIVE_WINDOW_TRANSFORM_ROT_90:  // 0x4
75             return VK_SURFACE_TRANSFORM_ROTATE_90_BIT_KHR;
76         // case NATIVE_WINDOW_TRANSFORM_FLIP_H | NATIVE_WINDOW_TRANSFORM_ROT_90:
77         //     return VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR;
78         // case NATIVE_WINDOW_TRANSFORM_FLIP_V | NATIVE_WINDOW_TRANSFORM_ROT_90:
79         //     return VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR;
80         case NATIVE_WINDOW_TRANSFORM_ROT_270:  // FLIP_H | FLIP_V | ROT_90
81             return VK_SURFACE_TRANSFORM_ROTATE_270_BIT_KHR;
82         case NATIVE_WINDOW_TRANSFORM_INVERSE_DISPLAY:
83         default:
84             return VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
85     }
86 }
87 
InvertTransformToNative(VkSurfaceTransformFlagBitsKHR transform)88 int InvertTransformToNative(VkSurfaceTransformFlagBitsKHR transform) {
89     switch (transform) {
90         case VK_SURFACE_TRANSFORM_ROTATE_90_BIT_KHR:
91             return NATIVE_WINDOW_TRANSFORM_ROT_270;
92         case VK_SURFACE_TRANSFORM_ROTATE_180_BIT_KHR:
93             return NATIVE_WINDOW_TRANSFORM_ROT_180;
94         case VK_SURFACE_TRANSFORM_ROTATE_270_BIT_KHR:
95             return NATIVE_WINDOW_TRANSFORM_ROT_90;
96         // TODO(jessehall): See TODO in TranslateNativeToVulkanTransform.
97         // case VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR:
98         //     return NATIVE_WINDOW_TRANSFORM_FLIP_H;
99         // case VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR:
100         //     return NATIVE_WINDOW_TRANSFORM_FLIP_H |
101         //            NATIVE_WINDOW_TRANSFORM_ROT_90;
102         // case VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR:
103         //     return NATIVE_WINDOW_TRANSFORM_FLIP_V;
104         // case VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR:
105         //     return NATIVE_WINDOW_TRANSFORM_FLIP_V |
106         //            NATIVE_WINDOW_TRANSFORM_ROT_90;
107         case VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR:
108         case VK_SURFACE_TRANSFORM_INHERIT_BIT_KHR:
109         default:
110             return 0;
111     }
112 }
113 
114 class TimingInfo {
115    public:
116     TimingInfo() = default;
TimingInfo(const VkPresentTimeGOOGLE * qp,uint64_t nativeFrameId)117     TimingInfo(const VkPresentTimeGOOGLE* qp, uint64_t nativeFrameId)
118         : vals_{qp->presentID, qp->desiredPresentTime, 0, 0, 0},
119           native_frame_id_(nativeFrameId) {}
ready() const120     bool ready() const {
121         return (timestamp_desired_present_time_ !=
122                         NATIVE_WINDOW_TIMESTAMP_PENDING &&
123                 timestamp_actual_present_time_ !=
124                         NATIVE_WINDOW_TIMESTAMP_PENDING &&
125                 timestamp_render_complete_time_ !=
126                         NATIVE_WINDOW_TIMESTAMP_PENDING &&
127                 timestamp_composition_latch_time_ !=
128                         NATIVE_WINDOW_TIMESTAMP_PENDING);
129     }
calculate(int64_t rdur)130     void calculate(int64_t rdur) {
131         bool anyTimestampInvalid =
132                 (timestamp_actual_present_time_ ==
133                         NATIVE_WINDOW_TIMESTAMP_INVALID) ||
134                 (timestamp_render_complete_time_ ==
135                         NATIVE_WINDOW_TIMESTAMP_INVALID) ||
136                 (timestamp_composition_latch_time_ ==
137                         NATIVE_WINDOW_TIMESTAMP_INVALID);
138         if (anyTimestampInvalid) {
139             ALOGE("Unexpectedly received invalid timestamp.");
140             vals_.actualPresentTime = 0;
141             vals_.earliestPresentTime = 0;
142             vals_.presentMargin = 0;
143             return;
144         }
145 
146         vals_.actualPresentTime =
147                 static_cast<uint64_t>(timestamp_actual_present_time_);
148         int64_t margin = (timestamp_composition_latch_time_ -
149                            timestamp_render_complete_time_);
150         // Calculate vals_.earliestPresentTime, and potentially adjust
151         // vals_.presentMargin.  The initial value of vals_.earliestPresentTime
152         // is vals_.actualPresentTime.  If we can subtract rdur (the duration
153         // of a refresh cycle) from vals_.earliestPresentTime (and also from
154         // vals_.presentMargin) and still leave a positive margin, then we can
155         // report to the application that it could have presented earlier than
156         // it did (per the extension specification).  If for some reason, we
157         // can do this subtraction repeatedly, we do, since
158         // vals_.earliestPresentTime really is supposed to be the "earliest".
159         int64_t early_time = timestamp_actual_present_time_;
160         while ((margin > rdur) &&
161                ((early_time - rdur) > timestamp_composition_latch_time_)) {
162             early_time -= rdur;
163             margin -= rdur;
164         }
165         vals_.earliestPresentTime = static_cast<uint64_t>(early_time);
166         vals_.presentMargin = static_cast<uint64_t>(margin);
167     }
get_values(VkPastPresentationTimingGOOGLE * values) const168     void get_values(VkPastPresentationTimingGOOGLE* values) const {
169         *values = vals_;
170     }
171 
172    public:
173     VkPastPresentationTimingGOOGLE vals_ { 0, 0, 0, 0, 0 };
174 
175     uint64_t native_frame_id_ { 0 };
176     int64_t timestamp_desired_present_time_{ NATIVE_WINDOW_TIMESTAMP_PENDING };
177     int64_t timestamp_actual_present_time_ { NATIVE_WINDOW_TIMESTAMP_PENDING };
178     int64_t timestamp_render_complete_time_ { NATIVE_WINDOW_TIMESTAMP_PENDING };
179     int64_t timestamp_composition_latch_time_
180             { NATIVE_WINDOW_TIMESTAMP_PENDING };
181 };
182 
183 // ----------------------------------------------------------------------------
184 
185 struct Surface {
186     android::sp<ANativeWindow> window;
187     VkSwapchainKHR swapchain_handle;
188     uint64_t consumer_usage;
189 };
190 
HandleFromSurface(Surface * surface)191 VkSurfaceKHR HandleFromSurface(Surface* surface) {
192     return VkSurfaceKHR(reinterpret_cast<uint64_t>(surface));
193 }
194 
SurfaceFromHandle(VkSurfaceKHR handle)195 Surface* SurfaceFromHandle(VkSurfaceKHR handle) {
196     return reinterpret_cast<Surface*>(handle);
197 }
198 
199 // Maximum number of TimingInfo structs to keep per swapchain:
200 enum { MAX_TIMING_INFOS = 10 };
201 // Minimum number of frames to look for in the past (so we don't cause
202 // syncronous requests to Surface Flinger):
203 enum { MIN_NUM_FRAMES_AGO = 5 };
204 
205 struct Swapchain {
Swapchainvulkan::driver::__anon3017a7eb0111::Swapchain206     Swapchain(Surface& surface_,
207               uint32_t num_images_,
208               VkPresentModeKHR present_mode)
209         : surface(surface_),
210           num_images(num_images_),
211           mailbox_mode(present_mode == VK_PRESENT_MODE_MAILBOX_KHR),
212           frame_timestamps_enabled(false),
213           shared(present_mode == VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR ||
214                  present_mode == VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR) {
215         ANativeWindow* window = surface.window.get();
216         native_window_get_refresh_cycle_duration(
217             window,
218             &refresh_duration);
219     }
220 
221     Surface& surface;
222     uint32_t num_images;
223     bool mailbox_mode;
224     bool frame_timestamps_enabled;
225     int64_t refresh_duration;
226     bool shared;
227 
228     struct Image {
Imagevulkan::driver::__anon3017a7eb0111::Swapchain::Image229         Image() : image(VK_NULL_HANDLE), dequeue_fence(-1), dequeued(false) {}
230         VkImage image;
231         android::sp<ANativeWindowBuffer> buffer;
232         // The fence is only valid when the buffer is dequeued, and should be
233         // -1 any other time. When valid, we own the fd, and must ensure it is
234         // closed: either by closing it explicitly when queueing the buffer,
235         // or by passing ownership e.g. to ANativeWindow::cancelBuffer().
236         int dequeue_fence;
237         bool dequeued;
238     } images[android::BufferQueueDefs::NUM_BUFFER_SLOTS];
239 
240     android::Vector<TimingInfo> timing;
241 };
242 
HandleFromSwapchain(Swapchain * swapchain)243 VkSwapchainKHR HandleFromSwapchain(Swapchain* swapchain) {
244     return VkSwapchainKHR(reinterpret_cast<uint64_t>(swapchain));
245 }
246 
SwapchainFromHandle(VkSwapchainKHR handle)247 Swapchain* SwapchainFromHandle(VkSwapchainKHR handle) {
248     return reinterpret_cast<Swapchain*>(handle);
249 }
250 
ReleaseSwapchainImage(VkDevice device,ANativeWindow * window,int release_fence,Swapchain::Image & image)251 void ReleaseSwapchainImage(VkDevice device,
252                            ANativeWindow* window,
253                            int release_fence,
254                            Swapchain::Image& image) {
255     ALOG_ASSERT(release_fence == -1 || image.dequeued,
256                 "ReleaseSwapchainImage: can't provide a release fence for "
257                 "non-dequeued images");
258 
259     if (image.dequeued) {
260         if (release_fence >= 0) {
261             // We get here from vkQueuePresentKHR. The application is
262             // responsible for creating an execution dependency chain from
263             // vkAcquireNextImage (dequeue_fence) to vkQueuePresentKHR
264             // (release_fence), so we can drop the dequeue_fence here.
265             if (image.dequeue_fence >= 0)
266                 close(image.dequeue_fence);
267         } else {
268             // We get here during swapchain destruction, or various serious
269             // error cases e.g. when we can't create the release_fence during
270             // vkQueuePresentKHR. In non-error cases, the dequeue_fence should
271             // have already signalled, since the swapchain images are supposed
272             // to be idle before the swapchain is destroyed. In error cases,
273             // there may be rendering in flight to the image, but since we
274             // weren't able to create a release_fence, waiting for the
275             // dequeue_fence is about the best we can do.
276             release_fence = image.dequeue_fence;
277         }
278         image.dequeue_fence = -1;
279 
280         if (window) {
281             window->cancelBuffer(window, image.buffer.get(), release_fence);
282         } else {
283             if (release_fence >= 0) {
284                 sync_wait(release_fence, -1 /* forever */);
285                 close(release_fence);
286             }
287         }
288 
289         image.dequeued = false;
290     }
291 
292     if (image.image) {
293         GetData(device).driver.DestroyImage(device, image.image, nullptr);
294         image.image = VK_NULL_HANDLE;
295     }
296 
297     image.buffer.clear();
298 }
299 
OrphanSwapchain(VkDevice device,Swapchain * swapchain)300 void OrphanSwapchain(VkDevice device, Swapchain* swapchain) {
301     if (swapchain->surface.swapchain_handle != HandleFromSwapchain(swapchain))
302         return;
303     for (uint32_t i = 0; i < swapchain->num_images; i++) {
304         if (!swapchain->images[i].dequeued)
305             ReleaseSwapchainImage(device, nullptr, -1, swapchain->images[i]);
306     }
307     swapchain->surface.swapchain_handle = VK_NULL_HANDLE;
308     swapchain->timing.clear();
309 }
310 
get_num_ready_timings(Swapchain & swapchain)311 uint32_t get_num_ready_timings(Swapchain& swapchain) {
312     if (swapchain.timing.size() < MIN_NUM_FRAMES_AGO) {
313         return 0;
314     }
315 
316     uint32_t num_ready = 0;
317     const size_t num_timings = swapchain.timing.size() - MIN_NUM_FRAMES_AGO + 1;
318     for (uint32_t i = 0; i < num_timings; i++) {
319         TimingInfo& ti = swapchain.timing.editItemAt(i);
320         if (ti.ready()) {
321             // This TimingInfo is ready to be reported to the user.  Add it
322             // to the num_ready.
323             num_ready++;
324             continue;
325         }
326         // This TimingInfo is not yet ready to be reported to the user,
327         // and so we should look for any available timestamps that
328         // might make it ready.
329         int64_t desired_present_time = 0;
330         int64_t render_complete_time = 0;
331         int64_t composition_latch_time = 0;
332         int64_t actual_present_time = 0;
333         // Obtain timestamps:
334         int ret = native_window_get_frame_timestamps(
335             swapchain.surface.window.get(), ti.native_frame_id_,
336             &desired_present_time, &render_complete_time,
337             &composition_latch_time,
338             NULL,  //&first_composition_start_time,
339             NULL,  //&last_composition_start_time,
340             NULL,  //&composition_finish_time,
341             // TODO(ianelliott): Maybe ask if this one is
342             // supported, at startup time (since it may not be
343             // supported):
344             &actual_present_time,
345             NULL,  //&dequeue_ready_time,
346             NULL /*&reads_done_time*/);
347 
348         if (ret != android::NO_ERROR) {
349             continue;
350         }
351 
352         // Record the timestamp(s) we received, and then see if this TimingInfo
353         // is ready to be reported to the user:
354         ti.timestamp_desired_present_time_ = desired_present_time;
355         ti.timestamp_actual_present_time_ = actual_present_time;
356         ti.timestamp_render_complete_time_ = render_complete_time;
357         ti.timestamp_composition_latch_time_ = composition_latch_time;
358 
359         if (ti.ready()) {
360             // The TimingInfo has received enough timestamps, and should now
361             // use those timestamps to calculate the info that should be
362             // reported to the user:
363             ti.calculate(swapchain.refresh_duration);
364             num_ready++;
365         }
366     }
367     return num_ready;
368 }
369 
370 // TODO(ianelliott): DEAL WITH RETURN VALUE (e.g. VK_INCOMPLETE)!!!
copy_ready_timings(Swapchain & swapchain,uint32_t * count,VkPastPresentationTimingGOOGLE * timings)371 void copy_ready_timings(Swapchain& swapchain,
372                         uint32_t* count,
373                         VkPastPresentationTimingGOOGLE* timings) {
374     if (swapchain.timing.empty()) {
375         *count = 0;
376         return;
377     }
378 
379     size_t last_ready = swapchain.timing.size() - 1;
380     while (!swapchain.timing[last_ready].ready()) {
381         if (last_ready == 0) {
382             *count = 0;
383             return;
384         }
385         last_ready--;
386     }
387 
388     uint32_t num_copied = 0;
389     size_t num_to_remove = 0;
390     for (uint32_t i = 0; i <= last_ready && num_copied < *count; i++) {
391         const TimingInfo& ti = swapchain.timing[i];
392         if (ti.ready()) {
393             ti.get_values(&timings[num_copied]);
394             num_copied++;
395         }
396         num_to_remove++;
397     }
398 
399     // Discard old frames that aren't ready if newer frames are ready.
400     // We don't expect to get the timing info for those old frames.
401     swapchain.timing.removeItemsAt(0, num_to_remove);
402 
403     *count = num_copied;
404 }
405 
GetNativePixelFormat(VkFormat format)406 android_pixel_format GetNativePixelFormat(VkFormat format) {
407     android_pixel_format native_format = HAL_PIXEL_FORMAT_RGBA_8888;
408     switch (format) {
409         case VK_FORMAT_R8G8B8A8_UNORM:
410         case VK_FORMAT_R8G8B8A8_SRGB:
411             native_format = HAL_PIXEL_FORMAT_RGBA_8888;
412             break;
413         case VK_FORMAT_R5G6B5_UNORM_PACK16:
414             native_format = HAL_PIXEL_FORMAT_RGB_565;
415             break;
416         case VK_FORMAT_R16G16B16A16_SFLOAT:
417             native_format = HAL_PIXEL_FORMAT_RGBA_FP16;
418             break;
419         case VK_FORMAT_A2R10G10B10_UNORM_PACK32:
420             native_format = HAL_PIXEL_FORMAT_RGBA_1010102;
421             break;
422         default:
423             ALOGV("unsupported swapchain format %d", format);
424             break;
425     }
426     return native_format;
427 }
428 
GetNativeDataspace(VkColorSpaceKHR colorspace)429 android_dataspace GetNativeDataspace(VkColorSpaceKHR colorspace) {
430     switch (colorspace) {
431         case VK_COLOR_SPACE_SRGB_NONLINEAR_KHR:
432             return HAL_DATASPACE_V0_SRGB;
433         case VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT:
434             return HAL_DATASPACE_DISPLAY_P3;
435         case VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT:
436             return HAL_DATASPACE_V0_SCRGB_LINEAR;
437         case VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT:
438             return HAL_DATASPACE_V0_SCRGB;
439         case VK_COLOR_SPACE_DCI_P3_LINEAR_EXT:
440             return HAL_DATASPACE_DCI_P3_LINEAR;
441         case VK_COLOR_SPACE_DCI_P3_NONLINEAR_EXT:
442             return HAL_DATASPACE_DCI_P3;
443         case VK_COLOR_SPACE_BT709_LINEAR_EXT:
444             return HAL_DATASPACE_V0_SRGB_LINEAR;
445         case VK_COLOR_SPACE_BT709_NONLINEAR_EXT:
446             return HAL_DATASPACE_V0_SRGB;
447         case VK_COLOR_SPACE_BT2020_LINEAR_EXT:
448             return HAL_DATASPACE_BT2020_LINEAR;
449         case VK_COLOR_SPACE_HDR10_ST2084_EXT:
450             return static_cast<android_dataspace>(
451                 HAL_DATASPACE_STANDARD_BT2020 | HAL_DATASPACE_TRANSFER_ST2084 |
452                 HAL_DATASPACE_RANGE_FULL);
453         case VK_COLOR_SPACE_DOLBYVISION_EXT:
454             return static_cast<android_dataspace>(
455                 HAL_DATASPACE_STANDARD_BT2020 | HAL_DATASPACE_TRANSFER_ST2084 |
456                 HAL_DATASPACE_RANGE_FULL);
457         case VK_COLOR_SPACE_HDR10_HLG_EXT:
458             return static_cast<android_dataspace>(
459                 HAL_DATASPACE_STANDARD_BT2020 | HAL_DATASPACE_TRANSFER_HLG |
460                 HAL_DATASPACE_RANGE_FULL);
461         case VK_COLOR_SPACE_ADOBERGB_LINEAR_EXT:
462             return static_cast<android_dataspace>(
463                 HAL_DATASPACE_STANDARD_ADOBE_RGB |
464                 HAL_DATASPACE_TRANSFER_LINEAR | HAL_DATASPACE_RANGE_FULL);
465         case VK_COLOR_SPACE_ADOBERGB_NONLINEAR_EXT:
466             return HAL_DATASPACE_ADOBE_RGB;
467 
468         // Pass through is intended to allow app to provide data that is passed
469         // to the display system without modification.
470         case VK_COLOR_SPACE_PASS_THROUGH_EXT:
471             return HAL_DATASPACE_ARBITRARY;
472 
473         default:
474             // This indicates that we don't know about the
475             // dataspace specified and we should indicate that
476             // it's unsupported
477             return HAL_DATASPACE_UNKNOWN;
478     }
479 }
480 
481 }  // anonymous namespace
482 
483 VKAPI_ATTR
CreateAndroidSurfaceKHR(VkInstance instance,const VkAndroidSurfaceCreateInfoKHR * pCreateInfo,const VkAllocationCallbacks * allocator,VkSurfaceKHR * out_surface)484 VkResult CreateAndroidSurfaceKHR(
485     VkInstance instance,
486     const VkAndroidSurfaceCreateInfoKHR* pCreateInfo,
487     const VkAllocationCallbacks* allocator,
488     VkSurfaceKHR* out_surface) {
489     if (!allocator)
490         allocator = &GetData(instance).allocator;
491     void* mem = allocator->pfnAllocation(allocator->pUserData, sizeof(Surface),
492                                          alignof(Surface),
493                                          VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
494     if (!mem)
495         return VK_ERROR_OUT_OF_HOST_MEMORY;
496     Surface* surface = new (mem) Surface;
497 
498     surface->window = pCreateInfo->window;
499     surface->swapchain_handle = VK_NULL_HANDLE;
500     int err = native_window_get_consumer_usage(surface->window.get(),
501                                                &surface->consumer_usage);
502     if (err != android::NO_ERROR) {
503         ALOGE("native_window_get_consumer_usage() failed: %s (%d)",
504               strerror(-err), err);
505         surface->~Surface();
506         allocator->pfnFree(allocator->pUserData, surface);
507         return VK_ERROR_INITIALIZATION_FAILED;
508     }
509 
510     // TODO(jessehall): Create and use NATIVE_WINDOW_API_VULKAN.
511     err =
512         native_window_api_connect(surface->window.get(), NATIVE_WINDOW_API_EGL);
513     if (err != 0) {
514         // TODO(jessehall): Improve error reporting. Can we enumerate possible
515         // errors and translate them to valid Vulkan result codes?
516         ALOGE("native_window_api_connect() failed: %s (%d)", strerror(-err),
517               err);
518         surface->~Surface();
519         allocator->pfnFree(allocator->pUserData, surface);
520         return VK_ERROR_NATIVE_WINDOW_IN_USE_KHR;
521     }
522 
523     *out_surface = HandleFromSurface(surface);
524     return VK_SUCCESS;
525 }
526 
527 VKAPI_ATTR
DestroySurfaceKHR(VkInstance instance,VkSurfaceKHR surface_handle,const VkAllocationCallbacks * allocator)528 void DestroySurfaceKHR(VkInstance instance,
529                        VkSurfaceKHR surface_handle,
530                        const VkAllocationCallbacks* allocator) {
531     Surface* surface = SurfaceFromHandle(surface_handle);
532     if (!surface)
533         return;
534     native_window_api_disconnect(surface->window.get(), NATIVE_WINDOW_API_EGL);
535     ALOGV_IF(surface->swapchain_handle != VK_NULL_HANDLE,
536              "destroyed VkSurfaceKHR 0x%" PRIx64
537              " has active VkSwapchainKHR 0x%" PRIx64,
538              reinterpret_cast<uint64_t>(surface_handle),
539              reinterpret_cast<uint64_t>(surface->swapchain_handle));
540     surface->~Surface();
541     if (!allocator)
542         allocator = &GetData(instance).allocator;
543     allocator->pfnFree(allocator->pUserData, surface);
544 }
545 
546 VKAPI_ATTR
GetPhysicalDeviceSurfaceSupportKHR(VkPhysicalDevice,uint32_t,VkSurfaceKHR surface_handle,VkBool32 * supported)547 VkResult GetPhysicalDeviceSurfaceSupportKHR(VkPhysicalDevice /*pdev*/,
548                                             uint32_t /*queue_family*/,
549                                             VkSurfaceKHR surface_handle,
550                                             VkBool32* supported) {
551     const Surface* surface = SurfaceFromHandle(surface_handle);
552     if (!surface) {
553         return VK_ERROR_SURFACE_LOST_KHR;
554     }
555     const ANativeWindow* window = surface->window.get();
556 
557     int query_value;
558     int err = window->query(window, NATIVE_WINDOW_FORMAT, &query_value);
559     if (err != 0 || query_value < 0) {
560         ALOGE("NATIVE_WINDOW_FORMAT query failed: %s (%d) value=%d",
561               strerror(-err), err, query_value);
562         return VK_ERROR_SURFACE_LOST_KHR;
563     }
564 
565     android_pixel_format native_format =
566         static_cast<android_pixel_format>(query_value);
567 
568     bool format_supported = false;
569     switch (native_format) {
570         case HAL_PIXEL_FORMAT_RGBA_8888:
571         case HAL_PIXEL_FORMAT_RGB_565:
572             format_supported = true;
573             break;
574         default:
575             break;
576     }
577 
578     // USAGE_CPU_READ_MASK 0xFUL
579     // USAGE_CPU_WRITE_MASK (0xFUL << 4)
580     // The currently used bits are as below:
581     // USAGE_CPU_READ_RARELY = 2UL
582     // USAGE_CPU_READ_OFTEN = 3UL
583     // USAGE_CPU_WRITE_RARELY = (2UL << 4)
584     // USAGE_CPU_WRITE_OFTEN = (3UL << 4)
585     *supported = static_cast<VkBool32>(format_supported ||
586                                        (surface->consumer_usage & 0xFFUL) == 0);
587 
588     return VK_SUCCESS;
589 }
590 
591 VKAPI_ATTR
GetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice,VkSurfaceKHR surface,VkSurfaceCapabilitiesKHR * capabilities)592 VkResult GetPhysicalDeviceSurfaceCapabilitiesKHR(
593     VkPhysicalDevice /*pdev*/,
594     VkSurfaceKHR surface,
595     VkSurfaceCapabilitiesKHR* capabilities) {
596     int err;
597     ANativeWindow* window = SurfaceFromHandle(surface)->window.get();
598 
599     int width, height;
600     err = window->query(window, NATIVE_WINDOW_DEFAULT_WIDTH, &width);
601     if (err != 0) {
602         ALOGE("NATIVE_WINDOW_DEFAULT_WIDTH query failed: %s (%d)",
603               strerror(-err), err);
604         return VK_ERROR_SURFACE_LOST_KHR;
605     }
606     err = window->query(window, NATIVE_WINDOW_DEFAULT_HEIGHT, &height);
607     if (err != 0) {
608         ALOGE("NATIVE_WINDOW_DEFAULT_WIDTH query failed: %s (%d)",
609               strerror(-err), err);
610         return VK_ERROR_SURFACE_LOST_KHR;
611     }
612 
613     int transform_hint;
614     err = window->query(window, NATIVE_WINDOW_TRANSFORM_HINT, &transform_hint);
615     if (err != 0) {
616         ALOGE("NATIVE_WINDOW_TRANSFORM_HINT query failed: %s (%d)",
617               strerror(-err), err);
618         return VK_ERROR_SURFACE_LOST_KHR;
619     }
620 
621     // TODO(jessehall): Figure out what the min/max values should be.
622     int max_buffer_count;
623     err = window->query(window, NATIVE_WINDOW_MAX_BUFFER_COUNT, &max_buffer_count);
624     if (err != 0) {
625         ALOGE("NATIVE_WINDOW_MAX_BUFFER_COUNT query failed: %s (%d)",
626               strerror(-err), err);
627         return VK_ERROR_SURFACE_LOST_KHR;
628     }
629     capabilities->minImageCount = max_buffer_count == 1 ? 1 : 2;
630     capabilities->maxImageCount = static_cast<uint32_t>(max_buffer_count);
631 
632     capabilities->currentExtent =
633         VkExtent2D{static_cast<uint32_t>(width), static_cast<uint32_t>(height)};
634 
635     // TODO(jessehall): Figure out what the max extent should be. Maximum
636     // texture dimension maybe?
637     capabilities->minImageExtent = VkExtent2D{1, 1};
638     capabilities->maxImageExtent = VkExtent2D{4096, 4096};
639 
640     capabilities->maxImageArrayLayers = 1;
641 
642     capabilities->supportedTransforms = kSupportedTransforms;
643     capabilities->currentTransform =
644         TranslateNativeToVulkanTransform(transform_hint);
645 
646     // On Android, window composition is a WindowManager property, not something
647     // associated with the bufferqueue. It can't be changed from here.
648     capabilities->supportedCompositeAlpha = VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR;
649 
650     // TODO(jessehall): I think these are right, but haven't thought hard about
651     // it. Do we need to query the driver for support of any of these?
652     // Currently not included:
653     // - VK_IMAGE_USAGE_DEPTH_STENCIL_BIT: definitely not
654     // - VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT: definitely not
655     capabilities->supportedUsageFlags =
656         VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT |
657         VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT |
658         VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
659         VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
660 
661     return VK_SUCCESS;
662 }
663 
664 VKAPI_ATTR
GetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice pdev,VkSurfaceKHR surface_handle,uint32_t * count,VkSurfaceFormatKHR * formats)665 VkResult GetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice pdev,
666                                             VkSurfaceKHR surface_handle,
667                                             uint32_t* count,
668                                             VkSurfaceFormatKHR* formats) {
669     const InstanceData& instance_data = GetData(pdev);
670 
671     // TODO(jessehall): Fill out the set of supported formats. Longer term, add
672     // a new gralloc method to query whether a (format, usage) pair is
673     // supported, and check that for each gralloc format that corresponds to a
674     // Vulkan format. Shorter term, just add a few more formats to the ones
675     // hardcoded below.
676 
677     const VkSurfaceFormatKHR kFormats[] = {
678         {VK_FORMAT_R8G8B8A8_UNORM, VK_COLOR_SPACE_SRGB_NONLINEAR_KHR},
679         {VK_FORMAT_R8G8B8A8_SRGB, VK_COLOR_SPACE_SRGB_NONLINEAR_KHR},
680         {VK_FORMAT_R5G6B5_UNORM_PACK16, VK_COLOR_SPACE_SRGB_NONLINEAR_KHR},
681     };
682     const uint32_t kNumFormats = sizeof(kFormats) / sizeof(kFormats[0]);
683     uint32_t total_num_formats = kNumFormats;
684 
685     bool wide_color_support = false;
686     Surface& surface = *SurfaceFromHandle(surface_handle);
687     int err = native_window_get_wide_color_support(surface.window.get(),
688                                                    &wide_color_support);
689     if (err) {
690         // Not allowed to return a more sensible error code, so do this
691         return VK_ERROR_OUT_OF_HOST_MEMORY;
692     }
693     ALOGV("wide_color_support is: %d", wide_color_support);
694     wide_color_support =
695         wide_color_support &&
696         instance_data.hook_extensions.test(ProcHook::EXT_swapchain_colorspace);
697 
698     const VkSurfaceFormatKHR kWideColorFormats[] = {
699         {VK_FORMAT_R8G8B8A8_UNORM,
700          VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT},
701         {VK_FORMAT_R8G8B8A8_SRGB,
702          VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT},
703     };
704     const uint32_t kNumWideColorFormats =
705         sizeof(kWideColorFormats) / sizeof(kWideColorFormats[0]);
706     if (wide_color_support) {
707         total_num_formats += kNumWideColorFormats;
708     }
709 
710     VkResult result = VK_SUCCESS;
711     if (formats) {
712         uint32_t out_count = 0;
713         uint32_t transfer_count = 0;
714         if (*count < total_num_formats)
715             result = VK_INCOMPLETE;
716         transfer_count = std::min(*count, kNumFormats);
717         std::copy(kFormats, kFormats + transfer_count, formats);
718         out_count += transfer_count;
719         if (wide_color_support) {
720             transfer_count = std::min(*count - out_count, kNumWideColorFormats);
721             std::copy(kWideColorFormats, kWideColorFormats + transfer_count,
722                       formats + out_count);
723             out_count += transfer_count;
724         }
725         *count = out_count;
726     } else {
727         *count = total_num_formats;
728     }
729     return result;
730 }
731 
732 VKAPI_ATTR
GetPhysicalDeviceSurfaceCapabilities2KHR(VkPhysicalDevice physicalDevice,const VkPhysicalDeviceSurfaceInfo2KHR * pSurfaceInfo,VkSurfaceCapabilities2KHR * pSurfaceCapabilities)733 VkResult GetPhysicalDeviceSurfaceCapabilities2KHR(
734     VkPhysicalDevice physicalDevice,
735     const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
736     VkSurfaceCapabilities2KHR* pSurfaceCapabilities) {
737     VkResult result = GetPhysicalDeviceSurfaceCapabilitiesKHR(
738         physicalDevice, pSurfaceInfo->surface,
739         &pSurfaceCapabilities->surfaceCapabilities);
740 
741     VkSurfaceCapabilities2KHR* caps = pSurfaceCapabilities;
742     while (caps->pNext) {
743         caps = reinterpret_cast<VkSurfaceCapabilities2KHR*>(caps->pNext);
744 
745         switch (caps->sType) {
746             case VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR: {
747                 VkSharedPresentSurfaceCapabilitiesKHR* shared_caps =
748                     reinterpret_cast<VkSharedPresentSurfaceCapabilitiesKHR*>(
749                         caps);
750                 // Claim same set of usage flags are supported for
751                 // shared present modes as for other modes.
752                 shared_caps->sharedPresentSupportedUsageFlags =
753                     pSurfaceCapabilities->surfaceCapabilities
754                         .supportedUsageFlags;
755             } break;
756 
757             default:
758                 // Ignore all other extension structs
759                 break;
760         }
761     }
762 
763     return result;
764 }
765 
766 VKAPI_ATTR
GetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,const VkPhysicalDeviceSurfaceInfo2KHR * pSurfaceInfo,uint32_t * pSurfaceFormatCount,VkSurfaceFormat2KHR * pSurfaceFormats)767 VkResult GetPhysicalDeviceSurfaceFormats2KHR(
768     VkPhysicalDevice physicalDevice,
769     const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
770     uint32_t* pSurfaceFormatCount,
771     VkSurfaceFormat2KHR* pSurfaceFormats) {
772     if (!pSurfaceFormats) {
773         return GetPhysicalDeviceSurfaceFormatsKHR(physicalDevice,
774                                                   pSurfaceInfo->surface,
775                                                   pSurfaceFormatCount, nullptr);
776     } else {
777         // temp vector for forwarding; we'll marshal it into the pSurfaceFormats
778         // after the call.
779         android::Vector<VkSurfaceFormatKHR> surface_formats;
780         surface_formats.resize(*pSurfaceFormatCount);
781         VkResult result = GetPhysicalDeviceSurfaceFormatsKHR(
782             physicalDevice, pSurfaceInfo->surface, pSurfaceFormatCount,
783             &surface_formats.editItemAt(0));
784 
785         if (result == VK_SUCCESS || result == VK_INCOMPLETE) {
786             // marshal results individually due to stride difference.
787             // completely ignore any chained extension structs.
788             uint32_t formats_to_marshal = *pSurfaceFormatCount;
789             for (uint32_t i = 0u; i < formats_to_marshal; i++) {
790                 pSurfaceFormats[i].surfaceFormat = surface_formats[i];
791             }
792         }
793 
794         return result;
795     }
796 }
797 
798 VKAPI_ATTR
GetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice pdev,VkSurfaceKHR surface,uint32_t * count,VkPresentModeKHR * modes)799 VkResult GetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice pdev,
800                                                  VkSurfaceKHR surface,
801                                                  uint32_t* count,
802                                                  VkPresentModeKHR* modes) {
803     int err;
804     int query_value;
805     ANativeWindow* window = SurfaceFromHandle(surface)->window.get();
806 
807     err = window->query(window, NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS, &query_value);
808     if (err != 0 || query_value < 0) {
809         ALOGE("NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS query failed: %s (%d) value=%d",
810               strerror(-err), err, query_value);
811         return VK_ERROR_SURFACE_LOST_KHR;
812     }
813     uint32_t min_undequeued_buffers = static_cast<uint32_t>(query_value);
814 
815     err = window->query(window, NATIVE_WINDOW_MAX_BUFFER_COUNT, &query_value);
816     if (err != 0 || query_value < 0) {
817         ALOGE("NATIVE_WINDOW_MAX_BUFFER_COUNT query failed: %s (%d) value=%d",
818               strerror(-err), err, query_value);
819         return VK_ERROR_SURFACE_LOST_KHR;
820     }
821     uint32_t max_buffer_count = static_cast<uint32_t>(query_value);
822 
823     android::Vector<VkPresentModeKHR> present_modes;
824     if (min_undequeued_buffers + 1 < max_buffer_count)
825         present_modes.push_back(VK_PRESENT_MODE_MAILBOX_KHR);
826     present_modes.push_back(VK_PRESENT_MODE_FIFO_KHR);
827 
828     VkPhysicalDevicePresentationPropertiesANDROID present_properties;
829     if (QueryPresentationProperties(pdev, &present_properties)) {
830         if (present_properties.sharedImage) {
831             present_modes.push_back(VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR);
832             present_modes.push_back(VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR);
833         }
834     }
835 
836     uint32_t num_modes = uint32_t(present_modes.size());
837 
838     VkResult result = VK_SUCCESS;
839     if (modes) {
840         if (*count < num_modes)
841             result = VK_INCOMPLETE;
842         *count = std::min(*count, num_modes);
843         std::copy(present_modes.begin(), present_modes.begin() + int(*count), modes);
844     } else {
845         *count = num_modes;
846     }
847     return result;
848 }
849 
850 VKAPI_ATTR
GetDeviceGroupPresentCapabilitiesKHR(VkDevice,VkDeviceGroupPresentCapabilitiesKHR * pDeviceGroupPresentCapabilities)851 VkResult GetDeviceGroupPresentCapabilitiesKHR(
852     VkDevice,
853     VkDeviceGroupPresentCapabilitiesKHR* pDeviceGroupPresentCapabilities) {
854     ALOGV_IF(pDeviceGroupPresentCapabilities->sType !=
855                  VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR,
856              "vkGetDeviceGroupPresentCapabilitiesKHR: invalid "
857              "VkDeviceGroupPresentCapabilitiesKHR structure type %d",
858              pDeviceGroupPresentCapabilities->sType);
859 
860     memset(pDeviceGroupPresentCapabilities->presentMask, 0,
861            sizeof(pDeviceGroupPresentCapabilities->presentMask));
862 
863     // assume device group of size 1
864     pDeviceGroupPresentCapabilities->presentMask[0] = 1 << 0;
865     pDeviceGroupPresentCapabilities->modes =
866         VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR;
867 
868     return VK_SUCCESS;
869 }
870 
871 VKAPI_ATTR
GetDeviceGroupSurfacePresentModesKHR(VkDevice,VkSurfaceKHR,VkDeviceGroupPresentModeFlagsKHR * pModes)872 VkResult GetDeviceGroupSurfacePresentModesKHR(
873     VkDevice,
874     VkSurfaceKHR,
875     VkDeviceGroupPresentModeFlagsKHR* pModes) {
876     *pModes = VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR;
877     return VK_SUCCESS;
878 }
879 
880 VKAPI_ATTR
GetPhysicalDevicePresentRectanglesKHR(VkPhysicalDevice,VkSurfaceKHR surface,uint32_t * pRectCount,VkRect2D * pRects)881 VkResult GetPhysicalDevicePresentRectanglesKHR(VkPhysicalDevice,
882                                                VkSurfaceKHR surface,
883                                                uint32_t* pRectCount,
884                                                VkRect2D* pRects) {
885     if (!pRects) {
886         *pRectCount = 1;
887     } else {
888         uint32_t count = std::min(*pRectCount, 1u);
889         bool incomplete = *pRectCount < 1;
890 
891         *pRectCount = count;
892 
893         if (incomplete) {
894             return VK_INCOMPLETE;
895         }
896 
897         int err;
898         ANativeWindow* window = SurfaceFromHandle(surface)->window.get();
899 
900         int width = 0, height = 0;
901         err = window->query(window, NATIVE_WINDOW_DEFAULT_WIDTH, &width);
902         if (err != 0) {
903             ALOGE("NATIVE_WINDOW_DEFAULT_WIDTH query failed: %s (%d)",
904                   strerror(-err), err);
905         }
906         err = window->query(window, NATIVE_WINDOW_DEFAULT_HEIGHT, &height);
907         if (err != 0) {
908             ALOGE("NATIVE_WINDOW_DEFAULT_WIDTH query failed: %s (%d)",
909                   strerror(-err), err);
910         }
911 
912         // TODO: Return something better than "whole window"
913         pRects[0].offset.x = 0;
914         pRects[0].offset.y = 0;
915         pRects[0].extent = VkExtent2D{static_cast<uint32_t>(width),
916                                       static_cast<uint32_t>(height)};
917     }
918     return VK_SUCCESS;
919 }
920 
921 VKAPI_ATTR
CreateSwapchainKHR(VkDevice device,const VkSwapchainCreateInfoKHR * create_info,const VkAllocationCallbacks * allocator,VkSwapchainKHR * swapchain_handle)922 VkResult CreateSwapchainKHR(VkDevice device,
923                             const VkSwapchainCreateInfoKHR* create_info,
924                             const VkAllocationCallbacks* allocator,
925                             VkSwapchainKHR* swapchain_handle) {
926     int err;
927     VkResult result = VK_SUCCESS;
928 
929     ALOGV("vkCreateSwapchainKHR: surface=0x%" PRIx64
930           " minImageCount=%u imageFormat=%u imageColorSpace=%u"
931           " imageExtent=%ux%u imageUsage=%#x preTransform=%u presentMode=%u"
932           " oldSwapchain=0x%" PRIx64,
933           reinterpret_cast<uint64_t>(create_info->surface),
934           create_info->minImageCount, create_info->imageFormat,
935           create_info->imageColorSpace, create_info->imageExtent.width,
936           create_info->imageExtent.height, create_info->imageUsage,
937           create_info->preTransform, create_info->presentMode,
938           reinterpret_cast<uint64_t>(create_info->oldSwapchain));
939 
940     if (!allocator)
941         allocator = &GetData(device).allocator;
942 
943     android_pixel_format native_pixel_format =
944         GetNativePixelFormat(create_info->imageFormat);
945     android_dataspace native_dataspace =
946         GetNativeDataspace(create_info->imageColorSpace);
947     if (native_dataspace == HAL_DATASPACE_UNKNOWN) {
948         ALOGE(
949             "CreateSwapchainKHR(VkSwapchainCreateInfoKHR.imageColorSpace = %d) "
950             "failed: Unsupported color space",
951             create_info->imageColorSpace);
952         return VK_ERROR_INITIALIZATION_FAILED;
953     }
954 
955     ALOGV_IF(create_info->imageArrayLayers != 1,
956              "swapchain imageArrayLayers=%u not supported",
957              create_info->imageArrayLayers);
958     ALOGV_IF((create_info->preTransform & ~kSupportedTransforms) != 0,
959              "swapchain preTransform=%#x not supported",
960              create_info->preTransform);
961     ALOGV_IF(!(create_info->presentMode == VK_PRESENT_MODE_FIFO_KHR ||
962                create_info->presentMode == VK_PRESENT_MODE_MAILBOX_KHR ||
963                create_info->presentMode == VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR ||
964                create_info->presentMode == VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR),
965              "swapchain presentMode=%u not supported",
966              create_info->presentMode);
967 
968     Surface& surface = *SurfaceFromHandle(create_info->surface);
969 
970     if (surface.swapchain_handle != create_info->oldSwapchain) {
971         ALOGV("Can't create a swapchain for VkSurfaceKHR 0x%" PRIx64
972               " because it already has active swapchain 0x%" PRIx64
973               " but VkSwapchainCreateInfo::oldSwapchain=0x%" PRIx64,
974               reinterpret_cast<uint64_t>(create_info->surface),
975               reinterpret_cast<uint64_t>(surface.swapchain_handle),
976               reinterpret_cast<uint64_t>(create_info->oldSwapchain));
977         return VK_ERROR_NATIVE_WINDOW_IN_USE_KHR;
978     }
979     if (create_info->oldSwapchain != VK_NULL_HANDLE)
980         OrphanSwapchain(device, SwapchainFromHandle(create_info->oldSwapchain));
981 
982     // -- Reset the native window --
983     // The native window might have been used previously, and had its properties
984     // changed from defaults. That will affect the answer we get for queries
985     // like MIN_UNDEQUED_BUFFERS. Reset to a known/default state before we
986     // attempt such queries.
987 
988     // The native window only allows dequeueing all buffers before any have
989     // been queued, since after that point at least one is assumed to be in
990     // non-FREE state at any given time. Disconnecting and re-connecting
991     // orphans the previous buffers, getting us back to the state where we can
992     // dequeue all buffers.
993     err = native_window_api_disconnect(surface.window.get(),
994                                        NATIVE_WINDOW_API_EGL);
995     ALOGW_IF(err != 0, "native_window_api_disconnect failed: %s (%d)",
996              strerror(-err), err);
997     err =
998         native_window_api_connect(surface.window.get(), NATIVE_WINDOW_API_EGL);
999     ALOGW_IF(err != 0, "native_window_api_connect failed: %s (%d)",
1000              strerror(-err), err);
1001 
1002     err = native_window_set_buffer_count(surface.window.get(), 0);
1003     if (err != 0) {
1004         ALOGE("native_window_set_buffer_count(0) failed: %s (%d)",
1005               strerror(-err), err);
1006         return VK_ERROR_SURFACE_LOST_KHR;
1007     }
1008 
1009     int swap_interval =
1010         create_info->presentMode == VK_PRESENT_MODE_MAILBOX_KHR ? 0 : 1;
1011     err = surface.window->setSwapInterval(surface.window.get(), swap_interval);
1012     if (err != 0) {
1013         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1014         // errors and translate them to valid Vulkan result codes?
1015         ALOGE("native_window->setSwapInterval(1) failed: %s (%d)",
1016               strerror(-err), err);
1017         return VK_ERROR_SURFACE_LOST_KHR;
1018     }
1019 
1020     err = native_window_set_shared_buffer_mode(surface.window.get(), false);
1021     if (err != 0) {
1022         ALOGE("native_window_set_shared_buffer_mode(false) failed: %s (%d)",
1023               strerror(-err), err);
1024         return VK_ERROR_SURFACE_LOST_KHR;
1025     }
1026 
1027     err = native_window_set_auto_refresh(surface.window.get(), false);
1028     if (err != 0) {
1029         ALOGE("native_window_set_auto_refresh(false) failed: %s (%d)",
1030               strerror(-err), err);
1031         return VK_ERROR_SURFACE_LOST_KHR;
1032     }
1033 
1034     // -- Configure the native window --
1035 
1036     const auto& dispatch = GetData(device).driver;
1037 
1038     err = native_window_set_buffers_format(surface.window.get(),
1039                                            native_pixel_format);
1040     if (err != 0) {
1041         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1042         // errors and translate them to valid Vulkan result codes?
1043         ALOGE("native_window_set_buffers_format(%d) failed: %s (%d)",
1044               native_pixel_format, strerror(-err), err);
1045         return VK_ERROR_SURFACE_LOST_KHR;
1046     }
1047     err = native_window_set_buffers_data_space(surface.window.get(),
1048                                                native_dataspace);
1049     if (err != 0) {
1050         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1051         // errors and translate them to valid Vulkan result codes?
1052         ALOGE("native_window_set_buffers_data_space(%d) failed: %s (%d)",
1053               native_dataspace, strerror(-err), err);
1054         return VK_ERROR_SURFACE_LOST_KHR;
1055     }
1056 
1057     err = native_window_set_buffers_dimensions(
1058         surface.window.get(), static_cast<int>(create_info->imageExtent.width),
1059         static_cast<int>(create_info->imageExtent.height));
1060     if (err != 0) {
1061         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1062         // errors and translate them to valid Vulkan result codes?
1063         ALOGE("native_window_set_buffers_dimensions(%d,%d) failed: %s (%d)",
1064               create_info->imageExtent.width, create_info->imageExtent.height,
1065               strerror(-err), err);
1066         return VK_ERROR_SURFACE_LOST_KHR;
1067     }
1068 
1069     // VkSwapchainCreateInfo::preTransform indicates the transformation the app
1070     // applied during rendering. native_window_set_transform() expects the
1071     // inverse: the transform the app is requesting that the compositor perform
1072     // during composition. With native windows, pre-transform works by rendering
1073     // with the same transform the compositor is applying (as in Vulkan), but
1074     // then requesting the inverse transform, so that when the compositor does
1075     // it's job the two transforms cancel each other out and the compositor ends
1076     // up applying an identity transform to the app's buffer.
1077     err = native_window_set_buffers_transform(
1078         surface.window.get(),
1079         InvertTransformToNative(create_info->preTransform));
1080     if (err != 0) {
1081         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1082         // errors and translate them to valid Vulkan result codes?
1083         ALOGE("native_window_set_buffers_transform(%d) failed: %s (%d)",
1084               InvertTransformToNative(create_info->preTransform),
1085               strerror(-err), err);
1086         return VK_ERROR_SURFACE_LOST_KHR;
1087     }
1088 
1089     err = native_window_set_scaling_mode(
1090         surface.window.get(), NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW);
1091     if (err != 0) {
1092         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1093         // errors and translate them to valid Vulkan result codes?
1094         ALOGE("native_window_set_scaling_mode(SCALE_TO_WINDOW) failed: %s (%d)",
1095               strerror(-err), err);
1096         return VK_ERROR_SURFACE_LOST_KHR;
1097     }
1098 
1099     VkSwapchainImageUsageFlagsANDROID swapchain_image_usage = 0;
1100     if (create_info->presentMode == VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR ||
1101         create_info->presentMode == VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR) {
1102         swapchain_image_usage |= VK_SWAPCHAIN_IMAGE_USAGE_SHARED_BIT_ANDROID;
1103         err = native_window_set_shared_buffer_mode(surface.window.get(), true);
1104         if (err != 0) {
1105             ALOGE("native_window_set_shared_buffer_mode failed: %s (%d)", strerror(-err), err);
1106             return VK_ERROR_SURFACE_LOST_KHR;
1107         }
1108     }
1109 
1110     if (create_info->presentMode == VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR) {
1111         err = native_window_set_auto_refresh(surface.window.get(), true);
1112         if (err != 0) {
1113             ALOGE("native_window_set_auto_refresh failed: %s (%d)", strerror(-err), err);
1114             return VK_ERROR_SURFACE_LOST_KHR;
1115         }
1116     }
1117 
1118     int query_value;
1119     err = surface.window->query(surface.window.get(),
1120                                 NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS,
1121                                 &query_value);
1122     if (err != 0 || query_value < 0) {
1123         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1124         // errors and translate them to valid Vulkan result codes?
1125         ALOGE("window->query failed: %s (%d) value=%d", strerror(-err), err,
1126               query_value);
1127         return VK_ERROR_SURFACE_LOST_KHR;
1128     }
1129     uint32_t min_undequeued_buffers = static_cast<uint32_t>(query_value);
1130     uint32_t num_images =
1131         (create_info->minImageCount - 1) + min_undequeued_buffers;
1132 
1133     // Lower layer insists that we have at least two buffers. This is wasteful
1134     // and we'd like to relax it in the shared case, but not all the pieces are
1135     // in place for that to work yet. Note we only lie to the lower layer-- we
1136     // don't want to give the app back a swapchain with extra images (which they
1137     // can't actually use!).
1138     err = native_window_set_buffer_count(surface.window.get(), std::max(2u, num_images));
1139     if (err != 0) {
1140         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1141         // errors and translate them to valid Vulkan result codes?
1142         ALOGE("native_window_set_buffer_count(%d) failed: %s (%d)", num_images,
1143               strerror(-err), err);
1144         return VK_ERROR_SURFACE_LOST_KHR;
1145     }
1146 
1147     int32_t legacy_usage = 0;
1148     if (dispatch.GetSwapchainGrallocUsage2ANDROID) {
1149         uint64_t consumer_usage, producer_usage;
1150         result = dispatch.GetSwapchainGrallocUsage2ANDROID(
1151             device, create_info->imageFormat, create_info->imageUsage,
1152             swapchain_image_usage, &consumer_usage, &producer_usage);
1153         if (result != VK_SUCCESS) {
1154             ALOGE("vkGetSwapchainGrallocUsage2ANDROID failed: %d", result);
1155             return VK_ERROR_SURFACE_LOST_KHR;
1156         }
1157         legacy_usage =
1158             android_convertGralloc1To0Usage(producer_usage, consumer_usage);
1159     } else if (dispatch.GetSwapchainGrallocUsageANDROID) {
1160         result = dispatch.GetSwapchainGrallocUsageANDROID(
1161             device, create_info->imageFormat, create_info->imageUsage,
1162             &legacy_usage);
1163         if (result != VK_SUCCESS) {
1164             ALOGE("vkGetSwapchainGrallocUsageANDROID failed: %d", result);
1165             return VK_ERROR_SURFACE_LOST_KHR;
1166         }
1167     }
1168     uint64_t native_usage = static_cast<uint64_t>(legacy_usage);
1169 
1170     bool createProtectedSwapchain = false;
1171     if (create_info->flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) {
1172         createProtectedSwapchain = true;
1173         native_usage |= BufferUsage::PROTECTED;
1174     }
1175     err = native_window_set_usage(surface.window.get(), native_usage);
1176     if (err != 0) {
1177         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1178         // errors and translate them to valid Vulkan result codes?
1179         ALOGE("native_window_set_usage failed: %s (%d)", strerror(-err), err);
1180         return VK_ERROR_SURFACE_LOST_KHR;
1181     }
1182 
1183     // -- Allocate our Swapchain object --
1184     // After this point, we must deallocate the swapchain on error.
1185 
1186     void* mem = allocator->pfnAllocation(allocator->pUserData,
1187                                          sizeof(Swapchain), alignof(Swapchain),
1188                                          VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
1189     if (!mem)
1190         return VK_ERROR_OUT_OF_HOST_MEMORY;
1191     Swapchain* swapchain =
1192         new (mem) Swapchain(surface, num_images, create_info->presentMode);
1193 
1194     // -- Dequeue all buffers and create a VkImage for each --
1195     // Any failures during or after this must cancel the dequeued buffers.
1196 
1197     VkSwapchainImageCreateInfoANDROID swapchain_image_create = {
1198 #pragma clang diagnostic push
1199 #pragma clang diagnostic ignored "-Wold-style-cast"
1200         .sType = VK_STRUCTURE_TYPE_SWAPCHAIN_IMAGE_CREATE_INFO_ANDROID,
1201 #pragma clang diagnostic pop
1202         .pNext = nullptr,
1203         .usage = swapchain_image_usage,
1204     };
1205     VkNativeBufferANDROID image_native_buffer = {
1206 #pragma clang diagnostic push
1207 #pragma clang diagnostic ignored "-Wold-style-cast"
1208         .sType = VK_STRUCTURE_TYPE_NATIVE_BUFFER_ANDROID,
1209 #pragma clang diagnostic pop
1210         .pNext = &swapchain_image_create,
1211     };
1212     VkImageCreateInfo image_create = {
1213         .sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO,
1214         .pNext = &image_native_buffer,
1215         .imageType = VK_IMAGE_TYPE_2D,
1216         .format = create_info->imageFormat,
1217         .extent = {0, 0, 1},
1218         .mipLevels = 1,
1219         .arrayLayers = 1,
1220         .samples = VK_SAMPLE_COUNT_1_BIT,
1221         .tiling = VK_IMAGE_TILING_OPTIMAL,
1222         .usage = create_info->imageUsage,
1223         .flags = createProtectedSwapchain ? VK_IMAGE_CREATE_PROTECTED_BIT : 0u,
1224         .sharingMode = create_info->imageSharingMode,
1225         .queueFamilyIndexCount = create_info->queueFamilyIndexCount,
1226         .pQueueFamilyIndices = create_info->pQueueFamilyIndices,
1227     };
1228 
1229     for (uint32_t i = 0; i < num_images; i++) {
1230         Swapchain::Image& img = swapchain->images[i];
1231 
1232         ANativeWindowBuffer* buffer;
1233         err = surface.window->dequeueBuffer(surface.window.get(), &buffer,
1234                                             &img.dequeue_fence);
1235         if (err != 0) {
1236             // TODO(jessehall): Improve error reporting. Can we enumerate
1237             // possible errors and translate them to valid Vulkan result codes?
1238             ALOGE("dequeueBuffer[%u] failed: %s (%d)", i, strerror(-err), err);
1239             result = VK_ERROR_SURFACE_LOST_KHR;
1240             break;
1241         }
1242         img.buffer = buffer;
1243         img.dequeued = true;
1244 
1245         image_create.extent =
1246             VkExtent3D{static_cast<uint32_t>(img.buffer->width),
1247                        static_cast<uint32_t>(img.buffer->height),
1248                        1};
1249         image_native_buffer.handle = img.buffer->handle;
1250         image_native_buffer.stride = img.buffer->stride;
1251         image_native_buffer.format = img.buffer->format;
1252         image_native_buffer.usage = int(img.buffer->usage);
1253         android_convertGralloc0To1Usage(int(img.buffer->usage),
1254             &image_native_buffer.usage2.producer,
1255             &image_native_buffer.usage2.consumer);
1256 
1257         result =
1258             dispatch.CreateImage(device, &image_create, nullptr, &img.image);
1259         if (result != VK_SUCCESS) {
1260             ALOGD("vkCreateImage w/ native buffer failed: %u", result);
1261             break;
1262         }
1263     }
1264 
1265     // -- Cancel all buffers, returning them to the queue --
1266     // If an error occurred before, also destroy the VkImage and release the
1267     // buffer reference. Otherwise, we retain a strong reference to the buffer.
1268     //
1269     // TODO(jessehall): The error path here is the same as DestroySwapchain,
1270     // but not the non-error path. Should refactor/unify.
1271     for (uint32_t i = 0; i < num_images; i++) {
1272         Swapchain::Image& img = swapchain->images[i];
1273         if (img.dequeued) {
1274             if (!swapchain->shared) {
1275                 surface.window->cancelBuffer(surface.window.get(), img.buffer.get(),
1276                                              img.dequeue_fence);
1277                 img.dequeue_fence = -1;
1278                 img.dequeued = false;
1279             }
1280         }
1281         if (result != VK_SUCCESS) {
1282             if (img.image)
1283                 dispatch.DestroyImage(device, img.image, nullptr);
1284         }
1285     }
1286 
1287     if (result != VK_SUCCESS) {
1288         swapchain->~Swapchain();
1289         allocator->pfnFree(allocator->pUserData, swapchain);
1290         return result;
1291     }
1292 
1293     surface.swapchain_handle = HandleFromSwapchain(swapchain);
1294     *swapchain_handle = surface.swapchain_handle;
1295     return VK_SUCCESS;
1296 }
1297 
1298 VKAPI_ATTR
DestroySwapchainKHR(VkDevice device,VkSwapchainKHR swapchain_handle,const VkAllocationCallbacks * allocator)1299 void DestroySwapchainKHR(VkDevice device,
1300                          VkSwapchainKHR swapchain_handle,
1301                          const VkAllocationCallbacks* allocator) {
1302     const auto& dispatch = GetData(device).driver;
1303     Swapchain* swapchain = SwapchainFromHandle(swapchain_handle);
1304     if (!swapchain)
1305         return;
1306     bool active = swapchain->surface.swapchain_handle == swapchain_handle;
1307     ANativeWindow* window = active ? swapchain->surface.window.get() : nullptr;
1308 
1309     if (swapchain->frame_timestamps_enabled) {
1310         native_window_enable_frame_timestamps(window, false);
1311     }
1312     for (uint32_t i = 0; i < swapchain->num_images; i++)
1313         ReleaseSwapchainImage(device, window, -1, swapchain->images[i]);
1314     if (active)
1315         swapchain->surface.swapchain_handle = VK_NULL_HANDLE;
1316     if (!allocator)
1317         allocator = &GetData(device).allocator;
1318     swapchain->~Swapchain();
1319     allocator->pfnFree(allocator->pUserData, swapchain);
1320 }
1321 
1322 VKAPI_ATTR
GetSwapchainImagesKHR(VkDevice,VkSwapchainKHR swapchain_handle,uint32_t * count,VkImage * images)1323 VkResult GetSwapchainImagesKHR(VkDevice,
1324                                VkSwapchainKHR swapchain_handle,
1325                                uint32_t* count,
1326                                VkImage* images) {
1327     Swapchain& swapchain = *SwapchainFromHandle(swapchain_handle);
1328     ALOGW_IF(swapchain.surface.swapchain_handle != swapchain_handle,
1329              "getting images for non-active swapchain 0x%" PRIx64
1330              "; only dequeued image handles are valid",
1331              reinterpret_cast<uint64_t>(swapchain_handle));
1332     VkResult result = VK_SUCCESS;
1333     if (images) {
1334         uint32_t n = swapchain.num_images;
1335         if (*count < swapchain.num_images) {
1336             n = *count;
1337             result = VK_INCOMPLETE;
1338         }
1339         for (uint32_t i = 0; i < n; i++)
1340             images[i] = swapchain.images[i].image;
1341         *count = n;
1342     } else {
1343         *count = swapchain.num_images;
1344     }
1345     return result;
1346 }
1347 
1348 VKAPI_ATTR
AcquireNextImageKHR(VkDevice device,VkSwapchainKHR swapchain_handle,uint64_t timeout,VkSemaphore semaphore,VkFence vk_fence,uint32_t * image_index)1349 VkResult AcquireNextImageKHR(VkDevice device,
1350                              VkSwapchainKHR swapchain_handle,
1351                              uint64_t timeout,
1352                              VkSemaphore semaphore,
1353                              VkFence vk_fence,
1354                              uint32_t* image_index) {
1355     Swapchain& swapchain = *SwapchainFromHandle(swapchain_handle);
1356     ANativeWindow* window = swapchain.surface.window.get();
1357     VkResult result;
1358     int err;
1359 
1360     if (swapchain.surface.swapchain_handle != swapchain_handle)
1361         return VK_ERROR_OUT_OF_DATE_KHR;
1362 
1363     ALOGW_IF(
1364         timeout != UINT64_MAX,
1365         "vkAcquireNextImageKHR: non-infinite timeouts not yet implemented");
1366 
1367     if (swapchain.shared) {
1368         // In shared mode, we keep the buffer dequeued all the time, so we don't
1369         // want to dequeue a buffer here. Instead, just ask the driver to ensure
1370         // the semaphore and fence passed to us will be signalled.
1371         *image_index = 0;
1372         result = GetData(device).driver.AcquireImageANDROID(
1373                 device, swapchain.images[*image_index].image, -1, semaphore, vk_fence);
1374         return result;
1375     }
1376 
1377     ANativeWindowBuffer* buffer;
1378     int fence_fd;
1379     err = window->dequeueBuffer(window, &buffer, &fence_fd);
1380     if (err != 0) {
1381         // TODO(jessehall): Improve error reporting. Can we enumerate possible
1382         // errors and translate them to valid Vulkan result codes?
1383         ALOGE("dequeueBuffer failed: %s (%d)", strerror(-err), err);
1384         return VK_ERROR_SURFACE_LOST_KHR;
1385     }
1386 
1387     uint32_t idx;
1388     for (idx = 0; idx < swapchain.num_images; idx++) {
1389         if (swapchain.images[idx].buffer.get() == buffer) {
1390             swapchain.images[idx].dequeued = true;
1391             swapchain.images[idx].dequeue_fence = fence_fd;
1392             break;
1393         }
1394     }
1395     if (idx == swapchain.num_images) {
1396         ALOGE("dequeueBuffer returned unrecognized buffer");
1397         window->cancelBuffer(window, buffer, fence_fd);
1398         return VK_ERROR_OUT_OF_DATE_KHR;
1399     }
1400 
1401     int fence_clone = -1;
1402     if (fence_fd != -1) {
1403         fence_clone = dup(fence_fd);
1404         if (fence_clone == -1) {
1405             ALOGE("dup(fence) failed, stalling until signalled: %s (%d)",
1406                   strerror(errno), errno);
1407             sync_wait(fence_fd, -1 /* forever */);
1408         }
1409     }
1410 
1411     result = GetData(device).driver.AcquireImageANDROID(
1412         device, swapchain.images[idx].image, fence_clone, semaphore, vk_fence);
1413     if (result != VK_SUCCESS) {
1414         // NOTE: we're relying on AcquireImageANDROID to close fence_clone,
1415         // even if the call fails. We could close it ourselves on failure, but
1416         // that would create a race condition if the driver closes it on a
1417         // failure path: some other thread might create an fd with the same
1418         // number between the time the driver closes it and the time we close
1419         // it. We must assume one of: the driver *always* closes it even on
1420         // failure, or *never* closes it on failure.
1421         window->cancelBuffer(window, buffer, fence_fd);
1422         swapchain.images[idx].dequeued = false;
1423         swapchain.images[idx].dequeue_fence = -1;
1424         return result;
1425     }
1426 
1427     *image_index = idx;
1428     return VK_SUCCESS;
1429 }
1430 
1431 VKAPI_ATTR
AcquireNextImage2KHR(VkDevice device,const VkAcquireNextImageInfoKHR * pAcquireInfo,uint32_t * pImageIndex)1432 VkResult AcquireNextImage2KHR(VkDevice device,
1433                               const VkAcquireNextImageInfoKHR* pAcquireInfo,
1434                               uint32_t* pImageIndex) {
1435     // TODO: this should actually be the other way around and this function
1436     // should handle any additional structures that get passed in
1437     return AcquireNextImageKHR(device, pAcquireInfo->swapchain,
1438                                pAcquireInfo->timeout, pAcquireInfo->semaphore,
1439                                pAcquireInfo->fence, pImageIndex);
1440 }
1441 
WorstPresentResult(VkResult a,VkResult b)1442 static VkResult WorstPresentResult(VkResult a, VkResult b) {
1443     // See the error ranking for vkQueuePresentKHR at the end of section 29.6
1444     // (in spec version 1.0.14).
1445     static const VkResult kWorstToBest[] = {
1446         VK_ERROR_DEVICE_LOST,
1447         VK_ERROR_SURFACE_LOST_KHR,
1448         VK_ERROR_OUT_OF_DATE_KHR,
1449         VK_ERROR_OUT_OF_DEVICE_MEMORY,
1450         VK_ERROR_OUT_OF_HOST_MEMORY,
1451         VK_SUBOPTIMAL_KHR,
1452     };
1453     for (auto result : kWorstToBest) {
1454         if (a == result || b == result)
1455             return result;
1456     }
1457     ALOG_ASSERT(a == VK_SUCCESS, "invalid vkQueuePresentKHR result %d", a);
1458     ALOG_ASSERT(b == VK_SUCCESS, "invalid vkQueuePresentKHR result %d", b);
1459     return a != VK_SUCCESS ? a : b;
1460 }
1461 
1462 VKAPI_ATTR
QueuePresentKHR(VkQueue queue,const VkPresentInfoKHR * present_info)1463 VkResult QueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* present_info) {
1464     ALOGV_IF(present_info->sType != VK_STRUCTURE_TYPE_PRESENT_INFO_KHR,
1465              "vkQueuePresentKHR: invalid VkPresentInfoKHR structure type %d",
1466              present_info->sType);
1467 
1468     VkDevice device = GetData(queue).driver_device;
1469     const auto& dispatch = GetData(queue).driver;
1470     VkResult final_result = VK_SUCCESS;
1471 
1472     // Look at the pNext chain for supported extension structs:
1473     const VkPresentRegionsKHR* present_regions = nullptr;
1474     const VkPresentTimesInfoGOOGLE* present_times = nullptr;
1475     const VkPresentRegionsKHR* next =
1476         reinterpret_cast<const VkPresentRegionsKHR*>(present_info->pNext);
1477     while (next) {
1478         switch (next->sType) {
1479             case VK_STRUCTURE_TYPE_PRESENT_REGIONS_KHR:
1480                 present_regions = next;
1481                 break;
1482             case VK_STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE:
1483                 present_times =
1484                     reinterpret_cast<const VkPresentTimesInfoGOOGLE*>(next);
1485                 break;
1486             default:
1487                 ALOGV("QueuePresentKHR ignoring unrecognized pNext->sType = %x",
1488                       next->sType);
1489                 break;
1490         }
1491         next = reinterpret_cast<const VkPresentRegionsKHR*>(next->pNext);
1492     }
1493     ALOGV_IF(
1494         present_regions &&
1495             present_regions->swapchainCount != present_info->swapchainCount,
1496         "VkPresentRegions::swapchainCount != VkPresentInfo::swapchainCount");
1497     ALOGV_IF(present_times &&
1498                  present_times->swapchainCount != present_info->swapchainCount,
1499              "VkPresentTimesInfoGOOGLE::swapchainCount != "
1500              "VkPresentInfo::swapchainCount");
1501     const VkPresentRegionKHR* regions =
1502         (present_regions) ? present_regions->pRegions : nullptr;
1503     const VkPresentTimeGOOGLE* times =
1504         (present_times) ? present_times->pTimes : nullptr;
1505     const VkAllocationCallbacks* allocator = &GetData(device).allocator;
1506     android_native_rect_t* rects = nullptr;
1507     uint32_t nrects = 0;
1508 
1509     for (uint32_t sc = 0; sc < present_info->swapchainCount; sc++) {
1510         Swapchain& swapchain =
1511             *SwapchainFromHandle(present_info->pSwapchains[sc]);
1512         uint32_t image_idx = present_info->pImageIndices[sc];
1513         Swapchain::Image& img = swapchain.images[image_idx];
1514         const VkPresentRegionKHR* region =
1515             (regions && !swapchain.mailbox_mode) ? &regions[sc] : nullptr;
1516         const VkPresentTimeGOOGLE* time = (times) ? &times[sc] : nullptr;
1517         VkResult swapchain_result = VK_SUCCESS;
1518         VkResult result;
1519         int err;
1520 
1521         int fence = -1;
1522         result = dispatch.QueueSignalReleaseImageANDROID(
1523             queue, present_info->waitSemaphoreCount,
1524             present_info->pWaitSemaphores, img.image, &fence);
1525         if (result != VK_SUCCESS) {
1526             ALOGE("QueueSignalReleaseImageANDROID failed: %d", result);
1527             swapchain_result = result;
1528         }
1529 
1530         if (swapchain.surface.swapchain_handle ==
1531             present_info->pSwapchains[sc]) {
1532             ANativeWindow* window = swapchain.surface.window.get();
1533             if (swapchain_result == VK_SUCCESS) {
1534                 if (region) {
1535                     // Process the incremental-present hint for this swapchain:
1536                     uint32_t rcount = region->rectangleCount;
1537                     if (rcount > nrects) {
1538                         android_native_rect_t* new_rects =
1539                             static_cast<android_native_rect_t*>(
1540                                 allocator->pfnReallocation(
1541                                     allocator->pUserData, rects,
1542                                     sizeof(android_native_rect_t) * rcount,
1543                                     alignof(android_native_rect_t),
1544                                     VK_SYSTEM_ALLOCATION_SCOPE_COMMAND));
1545                         if (new_rects) {
1546                             rects = new_rects;
1547                             nrects = rcount;
1548                         } else {
1549                             rcount = 0;  // Ignore the hint for this swapchain
1550                         }
1551                     }
1552                     for (uint32_t r = 0; r < rcount; ++r) {
1553                         if (region->pRectangles[r].layer > 0) {
1554                             ALOGV(
1555                                 "vkQueuePresentKHR ignoring invalid layer "
1556                                 "(%u); using layer 0 instead",
1557                                 region->pRectangles[r].layer);
1558                         }
1559                         int x = region->pRectangles[r].offset.x;
1560                         int y = region->pRectangles[r].offset.y;
1561                         int width = static_cast<int>(
1562                             region->pRectangles[r].extent.width);
1563                         int height = static_cast<int>(
1564                             region->pRectangles[r].extent.height);
1565                         android_native_rect_t* cur_rect = &rects[r];
1566                         cur_rect->left = x;
1567                         cur_rect->top = y + height;
1568                         cur_rect->right = x + width;
1569                         cur_rect->bottom = y;
1570                     }
1571                     native_window_set_surface_damage(window, rects, rcount);
1572                 }
1573                 if (time) {
1574                     if (!swapchain.frame_timestamps_enabled) {
1575                         ALOGV(
1576                             "Calling "
1577                             "native_window_enable_frame_timestamps(true)");
1578                         native_window_enable_frame_timestamps(window, true);
1579                         swapchain.frame_timestamps_enabled = true;
1580                     }
1581 
1582                     // Record the nativeFrameId so it can be later correlated to
1583                     // this present.
1584                     uint64_t nativeFrameId = 0;
1585                     err = native_window_get_next_frame_id(
1586                             window, &nativeFrameId);
1587                     if (err != android::NO_ERROR) {
1588                         ALOGE("Failed to get next native frame ID.");
1589                     }
1590 
1591                     // Add a new timing record with the user's presentID and
1592                     // the nativeFrameId.
1593                     swapchain.timing.push_back(TimingInfo(time, nativeFrameId));
1594                     while (swapchain.timing.size() > MAX_TIMING_INFOS) {
1595                         swapchain.timing.removeAt(0);
1596                     }
1597                     if (time->desiredPresentTime) {
1598                         // Set the desiredPresentTime:
1599                         ALOGV(
1600                             "Calling "
1601                             "native_window_set_buffers_timestamp(%" PRId64 ")",
1602                             time->desiredPresentTime);
1603                         native_window_set_buffers_timestamp(
1604                             window,
1605                             static_cast<int64_t>(time->desiredPresentTime));
1606                     }
1607                 }
1608 
1609                 err = window->queueBuffer(window, img.buffer.get(), fence);
1610                 // queueBuffer always closes fence, even on error
1611                 if (err != 0) {
1612                     // TODO(jessehall): What now? We should probably cancel the
1613                     // buffer, I guess?
1614                     ALOGE("queueBuffer failed: %s (%d)", strerror(-err), err);
1615                     swapchain_result = WorstPresentResult(
1616                         swapchain_result, VK_ERROR_OUT_OF_DATE_KHR);
1617                 }
1618                 if (img.dequeue_fence >= 0) {
1619                     close(img.dequeue_fence);
1620                     img.dequeue_fence = -1;
1621                 }
1622                 img.dequeued = false;
1623 
1624                 // If the swapchain is in shared mode, immediately dequeue the
1625                 // buffer so it can be presented again without an intervening
1626                 // call to AcquireNextImageKHR. We expect to get the same buffer
1627                 // back from every call to dequeueBuffer in this mode.
1628                 if (swapchain.shared && swapchain_result == VK_SUCCESS) {
1629                     ANativeWindowBuffer* buffer;
1630                     int fence_fd;
1631                     err = window->dequeueBuffer(window, &buffer, &fence_fd);
1632                     if (err != 0) {
1633                         ALOGE("dequeueBuffer failed: %s (%d)", strerror(-err), err);
1634                         swapchain_result = WorstPresentResult(swapchain_result,
1635                             VK_ERROR_SURFACE_LOST_KHR);
1636                     }
1637                     else if (img.buffer != buffer) {
1638                         ALOGE("got wrong image back for shared swapchain");
1639                         swapchain_result = WorstPresentResult(swapchain_result,
1640                             VK_ERROR_SURFACE_LOST_KHR);
1641                     }
1642                     else {
1643                         img.dequeue_fence = fence_fd;
1644                         img.dequeued = true;
1645                     }
1646                 }
1647             }
1648             if (swapchain_result != VK_SUCCESS) {
1649                 ReleaseSwapchainImage(device, window, fence, img);
1650                 OrphanSwapchain(device, &swapchain);
1651             }
1652         } else {
1653             ReleaseSwapchainImage(device, nullptr, fence, img);
1654             swapchain_result = VK_ERROR_OUT_OF_DATE_KHR;
1655         }
1656 
1657         if (present_info->pResults)
1658             present_info->pResults[sc] = swapchain_result;
1659 
1660         if (swapchain_result != final_result)
1661             final_result = WorstPresentResult(final_result, swapchain_result);
1662     }
1663     if (rects) {
1664         allocator->pfnFree(allocator->pUserData, rects);
1665     }
1666 
1667     return final_result;
1668 }
1669 
1670 VKAPI_ATTR
GetRefreshCycleDurationGOOGLE(VkDevice,VkSwapchainKHR swapchain_handle,VkRefreshCycleDurationGOOGLE * pDisplayTimingProperties)1671 VkResult GetRefreshCycleDurationGOOGLE(
1672     VkDevice,
1673     VkSwapchainKHR swapchain_handle,
1674     VkRefreshCycleDurationGOOGLE* pDisplayTimingProperties) {
1675     Swapchain& swapchain = *SwapchainFromHandle(swapchain_handle);
1676     VkResult result = VK_SUCCESS;
1677 
1678     pDisplayTimingProperties->refreshDuration =
1679             static_cast<uint64_t>(swapchain.refresh_duration);
1680 
1681     return result;
1682 }
1683 
1684 VKAPI_ATTR
GetPastPresentationTimingGOOGLE(VkDevice,VkSwapchainKHR swapchain_handle,uint32_t * count,VkPastPresentationTimingGOOGLE * timings)1685 VkResult GetPastPresentationTimingGOOGLE(
1686     VkDevice,
1687     VkSwapchainKHR swapchain_handle,
1688     uint32_t* count,
1689     VkPastPresentationTimingGOOGLE* timings) {
1690     Swapchain& swapchain = *SwapchainFromHandle(swapchain_handle);
1691     ANativeWindow* window = swapchain.surface.window.get();
1692     VkResult result = VK_SUCCESS;
1693 
1694     if (!swapchain.frame_timestamps_enabled) {
1695         ALOGV("Calling native_window_enable_frame_timestamps(true)");
1696         native_window_enable_frame_timestamps(window, true);
1697         swapchain.frame_timestamps_enabled = true;
1698     }
1699 
1700     if (timings) {
1701         // TODO(ianelliott): plumb return value (e.g. VK_INCOMPLETE)
1702         copy_ready_timings(swapchain, count, timings);
1703     } else {
1704         *count = get_num_ready_timings(swapchain);
1705     }
1706 
1707     return result;
1708 }
1709 
1710 VKAPI_ATTR
GetSwapchainStatusKHR(VkDevice,VkSwapchainKHR swapchain_handle)1711 VkResult GetSwapchainStatusKHR(
1712     VkDevice,
1713     VkSwapchainKHR swapchain_handle) {
1714     Swapchain& swapchain = *SwapchainFromHandle(swapchain_handle);
1715     VkResult result = VK_SUCCESS;
1716 
1717     if (swapchain.surface.swapchain_handle != swapchain_handle) {
1718         return VK_ERROR_OUT_OF_DATE_KHR;
1719     }
1720 
1721     // TODO(chrisforbes): Implement this function properly
1722 
1723     return result;
1724 }
1725 
SetHdrMetadataEXT(VkDevice,uint32_t swapchainCount,const VkSwapchainKHR * pSwapchains,const VkHdrMetadataEXT * pHdrMetadataEXTs)1726 VKAPI_ATTR void SetHdrMetadataEXT(
1727     VkDevice,
1728     uint32_t swapchainCount,
1729     const VkSwapchainKHR* pSwapchains,
1730     const VkHdrMetadataEXT* pHdrMetadataEXTs) {
1731 
1732     for (uint32_t idx = 0; idx < swapchainCount; idx++) {
1733         Swapchain* swapchain = SwapchainFromHandle(pSwapchains[idx]);
1734         if (!swapchain)
1735             continue;
1736 
1737         if (swapchain->surface.swapchain_handle != pSwapchains[idx]) continue;
1738 
1739         ANativeWindow* window = swapchain->surface.window.get();
1740 
1741         VkHdrMetadataEXT vulkanMetadata = pHdrMetadataEXTs[idx];
1742         const android_smpte2086_metadata smpteMetdata = {
1743             {vulkanMetadata.displayPrimaryRed.x,
1744              vulkanMetadata.displayPrimaryRed.y},
1745             {vulkanMetadata.displayPrimaryGreen.x,
1746              vulkanMetadata.displayPrimaryGreen.y},
1747             {vulkanMetadata.displayPrimaryBlue.x,
1748              vulkanMetadata.displayPrimaryBlue.y},
1749             {vulkanMetadata.whitePoint.x, vulkanMetadata.whitePoint.y},
1750             vulkanMetadata.maxLuminance,
1751             vulkanMetadata.minLuminance};
1752         native_window_set_buffers_smpte2086_metadata(window, &smpteMetdata);
1753 
1754         const android_cta861_3_metadata cta8613Metadata = {
1755             vulkanMetadata.maxContentLightLevel,
1756             vulkanMetadata.maxFrameAverageLightLevel};
1757         native_window_set_buffers_cta861_3_metadata(window, &cta8613Metadata);
1758     }
1759 
1760     return;
1761 }
1762 
1763 }  // namespace driver
1764 }  // namespace vulkan
1765