api.cpp revision 94a2c0ecd4537c52e6b4a3ef9d119dce44627ca8 
1/*
2 * Copyright 2016 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// The API layer of the loader defines Vulkan API and manages layers.  The
18// entrypoints are generated and defined in api_dispatch.cpp.  Most of them
19// simply find the dispatch table and jump.
20//
21// There are a few of them requiring manual code for things such as layer
22// discovery or chaining.  They call into functions defined in this file.
23
24#include <stdlib.h>
25#include <string.h>
26#include <algorithm>
27#include <mutex>
28#include <new>
29#include <utility>
30#include <cutils/properties.h>
31#include <log/log.h>
32
33#include <vulkan/vk_layer_interface.h>
34#include "api.h"
35#include "driver.h"
36#include "layers_extensions.h"
37
38namespace vulkan {
39namespace api {
40
41namespace {
42
43// Provide overridden layer names when there are implicit layers.  No effect
44// otherwise.
45class OverrideLayerNames {
46   public:
47    OverrideLayerNames(bool is_instance, const VkAllocationCallbacks& allocator)
48        : is_instance_(is_instance),
49          allocator_(allocator),
50          scope_(VK_SYSTEM_ALLOCATION_SCOPE_COMMAND),
51          names_(nullptr),
52          name_count_(0),
53          implicit_layers_() {
54        implicit_layers_.result = VK_SUCCESS;
55    }
56
57    ~OverrideLayerNames() {
58        allocator_.pfnFree(allocator_.pUserData, names_);
59        allocator_.pfnFree(allocator_.pUserData, implicit_layers_.elements);
60        allocator_.pfnFree(allocator_.pUserData, implicit_layers_.name_pool);
61    }
62
63    VkResult Parse(const char* const* names, uint32_t count) {
64        AddImplicitLayers();
65
66        const auto& arr = implicit_layers_;
67        if (arr.result != VK_SUCCESS)
68            return arr.result;
69
70        // no need to override when there is no implicit layer
71        if (!arr.count)
72            return VK_SUCCESS;
73
74        names_ = AllocateNameArray(arr.count + count);
75        if (!names_)
76            return VK_ERROR_OUT_OF_HOST_MEMORY;
77
78        // add implicit layer names
79        for (uint32_t i = 0; i < arr.count; i++)
80            names_[i] = GetImplicitLayerName(i);
81
82        name_count_ = arr.count;
83
84        // add explicit layer names
85        for (uint32_t i = 0; i < count; i++) {
86            // ignore explicit layers that are also implicit
87            if (IsImplicitLayer(names[i]))
88                continue;
89
90            names_[name_count_++] = names[i];
91        }
92
93        return VK_SUCCESS;
94    }
95
96    const char* const* Names() const { return names_; }
97
98    uint32_t Count() const { return name_count_; }
99
100   private:
101    struct ImplicitLayer {
102        int priority;
103        size_t name_offset;
104    };
105
106    struct ImplicitLayerArray {
107        ImplicitLayer* elements;
108        uint32_t max_count;
109        uint32_t count;
110
111        char* name_pool;
112        size_t max_pool_size;
113        size_t pool_size;
114
115        VkResult result;
116    };
117
118    void AddImplicitLayers() {
119        if (!driver::Debuggable())
120            return;
121
122        ParseDebugVulkanLayers();
123        property_list(ParseDebugVulkanLayer, this);
124
125        // sort by priorities
126        auto& arr = implicit_layers_;
127        std::sort(arr.elements, arr.elements + arr.count,
128                  [](const ImplicitLayer& a, const ImplicitLayer& b) {
129                      return (a.priority < b.priority);
130                  });
131    }
132
133    void ParseDebugVulkanLayers() {
134        // debug.vulkan.layers specifies colon-separated layer names
135        char prop[PROPERTY_VALUE_MAX];
136        if (!property_get("debug.vulkan.layers", prop, ""))
137            return;
138
139        // assign negative/high priorities to them
140        int prio = -PROPERTY_VALUE_MAX;
141
142        const char* p = prop;
143        const char* delim;
144        while ((delim = strchr(p, ':'))) {
145            if (delim > p)
146                AddImplicitLayer(prio, p, static_cast<size_t>(delim - p));
147
148            prio++;
149            p = delim + 1;
150        }
151
152        if (p[0] != '\0')
153            AddImplicitLayer(prio, p, strlen(p));
154    }
155
156    static void ParseDebugVulkanLayer(const char* key,
157                                      const char* val,
158                                      void* user_data) {
159        static const char prefix[] = "debug.vulkan.layer.";
160        const size_t prefix_len = sizeof(prefix) - 1;
161
162        if (strncmp(key, prefix, prefix_len) || val[0] == '\0')
163            return;
164        key += prefix_len;
165
166        // debug.vulkan.layer.<priority>
167        int priority = -1;
168        if (key[0] >= '0' && key[0] <= '9')
169            priority = atoi(key);
170
171        if (priority < 0) {
172            ALOGW("Ignored implicit layer %s with invalid priority %s", val,
173                  key);
174            return;
175        }
176
177        OverrideLayerNames& override_layers =
178            *reinterpret_cast<OverrideLayerNames*>(user_data);
179        override_layers.AddImplicitLayer(priority, val, strlen(val));
180    }
181
182    void AddImplicitLayer(int priority, const char* name, size_t len) {
183        if (!GrowImplicitLayerArray(1, 0))
184            return;
185
186        auto& arr = implicit_layers_;
187        auto& layer = arr.elements[arr.count++];
188
189        layer.priority = priority;
190        layer.name_offset = AddImplicitLayerName(name, len);
191
192        ALOGV("Added implicit layer %s", GetImplicitLayerName(arr.count - 1));
193    }
194
195    size_t AddImplicitLayerName(const char* name, size_t len) {
196        if (!GrowImplicitLayerArray(0, len + 1))
197            return 0;
198
199        // add the name to the pool
200        auto& arr = implicit_layers_;
201        size_t offset = arr.pool_size;
202        char* dst = arr.name_pool + offset;
203
204        std::copy(name, name + len, dst);
205        dst[len] = '\0';
206
207        arr.pool_size += len + 1;
208
209        return offset;
210    }
211
212    bool GrowImplicitLayerArray(uint32_t layer_count, size_t name_size) {
213        const uint32_t initial_max_count = 16;
214        const size_t initial_max_pool_size = 512;
215
216        auto& arr = implicit_layers_;
217
218        // grow the element array if needed
219        while (arr.count + layer_count > arr.max_count) {
220            uint32_t new_max_count =
221                (arr.max_count) ? (arr.max_count << 1) : initial_max_count;
222            void* new_mem = nullptr;
223
224            if (new_max_count > arr.max_count) {
225                new_mem = allocator_.pfnReallocation(
226                    allocator_.pUserData, arr.elements,
227                    sizeof(ImplicitLayer) * new_max_count,
228                    alignof(ImplicitLayer), scope_);
229            }
230
231            if (!new_mem) {
232                arr.result = VK_ERROR_OUT_OF_HOST_MEMORY;
233                arr.count = 0;
234                return false;
235            }
236
237            arr.elements = reinterpret_cast<ImplicitLayer*>(new_mem);
238            arr.max_count = new_max_count;
239        }
240
241        // grow the name pool if needed
242        while (arr.pool_size + name_size > arr.max_pool_size) {
243            size_t new_max_pool_size = (arr.max_pool_size)
244                                           ? (arr.max_pool_size << 1)
245                                           : initial_max_pool_size;
246            void* new_mem = nullptr;
247
248            if (new_max_pool_size > arr.max_pool_size) {
249                new_mem = allocator_.pfnReallocation(
250                    allocator_.pUserData, arr.name_pool, new_max_pool_size,
251                    alignof(char), scope_);
252            }
253
254            if (!new_mem) {
255                arr.result = VK_ERROR_OUT_OF_HOST_MEMORY;
256                arr.pool_size = 0;
257                return false;
258            }
259
260            arr.name_pool = reinterpret_cast<char*>(new_mem);
261            arr.max_pool_size = new_max_pool_size;
262        }
263
264        return true;
265    }
266
267    const char* GetImplicitLayerName(uint32_t index) const {
268        const auto& arr = implicit_layers_;
269
270        // this may return nullptr when arr.result is not VK_SUCCESS
271        return implicit_layers_.name_pool + arr.elements[index].name_offset;
272    }
273
274    bool IsImplicitLayer(const char* name) const {
275        const auto& arr = implicit_layers_;
276
277        for (uint32_t i = 0; i < arr.count; i++) {
278            if (strcmp(name, GetImplicitLayerName(i)) == 0)
279                return true;
280        }
281
282        return false;
283    }
284
285    const char** AllocateNameArray(uint32_t count) const {
286        return reinterpret_cast<const char**>(allocator_.pfnAllocation(
287            allocator_.pUserData, sizeof(const char*) * count,
288            alignof(const char*), scope_));
289    }
290
291    const bool is_instance_;
292    const VkAllocationCallbacks& allocator_;
293    const VkSystemAllocationScope scope_;
294
295    const char** names_;
296    uint32_t name_count_;
297
298    ImplicitLayerArray implicit_layers_;
299};
300
301// Provide overridden extension names when there are implicit extensions.
302// No effect otherwise.
303//
304// This is used only to enable VK_EXT_debug_report.
305class OverrideExtensionNames {
306   public:
307    OverrideExtensionNames(bool is_instance,
308                           const VkAllocationCallbacks& allocator)
309        : is_instance_(is_instance),
310          allocator_(allocator),
311          scope_(VK_SYSTEM_ALLOCATION_SCOPE_COMMAND),
312          names_(nullptr),
313          name_count_(0),
314          install_debug_callback_(false) {}
315
316    ~OverrideExtensionNames() {
317        allocator_.pfnFree(allocator_.pUserData, names_);
318    }
319
320    VkResult Parse(const char* const* names, uint32_t count) {
321        // this is only for debug.vulkan.enable_callback
322        if (!EnableDebugCallback())
323            return VK_SUCCESS;
324
325        names_ = AllocateNameArray(count + 1);
326        if (!names_)
327            return VK_ERROR_OUT_OF_HOST_MEMORY;
328
329        std::copy(names, names + count, names_);
330
331        name_count_ = count;
332        names_[name_count_++] = "VK_EXT_debug_report";
333
334        install_debug_callback_ = true;
335
336        return VK_SUCCESS;
337    }
338
339    const char* const* Names() const { return names_; }
340
341    uint32_t Count() const { return name_count_; }
342
343    bool InstallDebugCallback() const { return install_debug_callback_; }
344
345   private:
346    bool EnableDebugCallback() const {
347        return (is_instance_ && driver::Debuggable() &&
348                property_get_bool("debug.vulkan.enable_callback", false));
349    }
350
351    const char** AllocateNameArray(uint32_t count) const {
352        return reinterpret_cast<const char**>(allocator_.pfnAllocation(
353            allocator_.pUserData, sizeof(const char*) * count,
354            alignof(const char*), scope_));
355    }
356
357    const bool is_instance_;
358    const VkAllocationCallbacks& allocator_;
359    const VkSystemAllocationScope scope_;
360
361    const char** names_;
362    uint32_t name_count_;
363    bool install_debug_callback_;
364};
365
366// vkCreateInstance and vkCreateDevice helpers with support for layer
367// chaining.
368class LayerChain {
369   public:
370    static VkResult CreateInstance(const VkInstanceCreateInfo* create_info,
371                                   const VkAllocationCallbacks* allocator,
372                                   VkInstance* instance_out);
373
374    static VkResult CreateDevice(VkPhysicalDevice physical_dev,
375                                 const VkDeviceCreateInfo* create_info,
376                                 const VkAllocationCallbacks* allocator,
377                                 VkDevice* dev_out);
378
379    static void DestroyInstance(VkInstance instance,
380                                const VkAllocationCallbacks* allocator);
381
382    static void DestroyDevice(VkDevice dev,
383                              const VkAllocationCallbacks* allocator);
384
385   private:
386    struct ActiveLayer {
387        LayerRef ref;
388        union {
389            VkLayerInstanceLink instance_link;
390            VkLayerDeviceLink device_link;
391        };
392    };
393
394    LayerChain(bool is_instance, const VkAllocationCallbacks& allocator);
395    ~LayerChain();
396
397    VkResult ActivateLayers(const char* const* layer_names,
398                            uint32_t layer_count,
399                            const char* const* extension_names,
400                            uint32_t extension_count);
401    ActiveLayer* AllocateLayerArray(uint32_t count) const;
402    VkResult LoadLayer(ActiveLayer& layer, const char* name);
403    void SetupLayerLinks();
404
405    bool Empty() const;
406    void ModifyCreateInfo(VkInstanceCreateInfo& info);
407    void ModifyCreateInfo(VkDeviceCreateInfo& info);
408
409    VkResult Create(const VkInstanceCreateInfo* create_info,
410                    const VkAllocationCallbacks* allocator,
411                    VkInstance* instance_out);
412
413    VkResult Create(VkPhysicalDevice physical_dev,
414                    const VkDeviceCreateInfo* create_info,
415                    const VkAllocationCallbacks* allocator,
416                    VkDevice* dev_out);
417
418    VkResult ValidateExtensions(const char* const* extension_names,
419                                uint32_t extension_count);
420    VkResult ValidateExtensions(VkPhysicalDevice physical_dev,
421                                const char* const* extension_names,
422                                uint32_t extension_count);
423    VkExtensionProperties* AllocateDriverExtensionArray(uint32_t count) const;
424    bool IsLayerExtension(const char* name) const;
425    bool IsDriverExtension(const char* name) const;
426
427    template <typename DataType>
428    void StealLayers(DataType& data);
429
430    static void DestroyLayers(ActiveLayer* layers,
431                              uint32_t count,
432                              const VkAllocationCallbacks& allocator);
433
434    static VKAPI_ATTR VkResult SetInstanceLoaderData(VkInstance instance,
435                                                     void* object);
436    static VKAPI_ATTR VkResult SetDeviceLoaderData(VkDevice device,
437                                                   void* object);
438
439    static VKAPI_ATTR VkBool32
440    DebugReportCallback(VkDebugReportFlagsEXT flags,
441                        VkDebugReportObjectTypeEXT obj_type,
442                        uint64_t obj,
443                        size_t location,
444                        int32_t msg_code,
445                        const char* layer_prefix,
446                        const char* msg,
447                        void* user_data);
448
449    const bool is_instance_;
450    const VkAllocationCallbacks& allocator_;
451
452    OverrideLayerNames override_layers_;
453    OverrideExtensionNames override_extensions_;
454
455    ActiveLayer* layers_;
456    uint32_t layer_count_;
457
458    PFN_vkGetInstanceProcAddr get_instance_proc_addr_;
459    PFN_vkGetDeviceProcAddr get_device_proc_addr_;
460
461    union {
462        VkLayerInstanceCreateInfo instance_chain_info_[2];
463        VkLayerDeviceCreateInfo device_chain_info_[2];
464    };
465
466    VkExtensionProperties* driver_extensions_;
467    uint32_t driver_extension_count_;
468};
469
470LayerChain::LayerChain(bool is_instance, const VkAllocationCallbacks& allocator)
471    : is_instance_(is_instance),
472      allocator_(allocator),
473      override_layers_(is_instance, allocator),
474      override_extensions_(is_instance, allocator),
475      layers_(nullptr),
476      layer_count_(0),
477      get_instance_proc_addr_(nullptr),
478      get_device_proc_addr_(nullptr),
479      driver_extensions_(nullptr),
480      driver_extension_count_(0) {}
481
482LayerChain::~LayerChain() {
483    allocator_.pfnFree(allocator_.pUserData, driver_extensions_);
484    DestroyLayers(layers_, layer_count_, allocator_);
485}
486
487VkResult LayerChain::ActivateLayers(const char* const* layer_names,
488                                    uint32_t layer_count,
489                                    const char* const* extension_names,
490                                    uint32_t extension_count) {
491    VkResult result = override_layers_.Parse(layer_names, layer_count);
492    if (result != VK_SUCCESS)
493        return result;
494
495    result = override_extensions_.Parse(extension_names, extension_count);
496    if (result != VK_SUCCESS)
497        return result;
498
499    if (override_layers_.Count()) {
500        layer_names = override_layers_.Names();
501        layer_count = override_layers_.Count();
502    }
503
504    if (!layer_count) {
505        // point head of chain to the driver
506        get_instance_proc_addr_ = driver::GetInstanceProcAddr;
507        if (!is_instance_)
508            get_device_proc_addr_ = driver::GetDeviceProcAddr;
509
510        return VK_SUCCESS;
511    }
512
513    layers_ = AllocateLayerArray(layer_count);
514    if (!layers_)
515        return VK_ERROR_OUT_OF_HOST_MEMORY;
516
517    // load layers
518    for (uint32_t i = 0; i < layer_count; i++) {
519        result = LoadLayer(layers_[i], layer_names[i]);
520        if (result != VK_SUCCESS)
521            return result;
522
523        // count loaded layers for proper destructions on errors
524        layer_count_++;
525    }
526
527    SetupLayerLinks();
528
529    return VK_SUCCESS;
530}
531
532LayerChain::ActiveLayer* LayerChain::AllocateLayerArray(uint32_t count) const {
533    VkSystemAllocationScope scope = (is_instance_)
534                                        ? VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE
535                                        : VK_SYSTEM_ALLOCATION_SCOPE_DEVICE;
536
537    return reinterpret_cast<ActiveLayer*>(allocator_.pfnAllocation(
538        allocator_.pUserData, sizeof(ActiveLayer) * count, alignof(ActiveLayer),
539        scope));
540}
541
542VkResult LayerChain::LoadLayer(ActiveLayer& layer, const char* name) {
543    if (is_instance_)
544        new (&layer) ActiveLayer{GetInstanceLayerRef(name), {}};
545    else
546        new (&layer) ActiveLayer{GetDeviceLayerRef(name), {}};
547
548    if (!layer.ref) {
549        ALOGE("Failed to load layer %s", name);
550        layer.ref.~LayerRef();
551        return VK_ERROR_LAYER_NOT_PRESENT;
552    }
553
554    ALOGI("Loaded %s layer %s", (is_instance_) ? "instance" : "device", name);
555
556    return VK_SUCCESS;
557}
558
559void LayerChain::SetupLayerLinks() {
560    if (is_instance_) {
561        for (uint32_t i = 0; i < layer_count_; i++) {
562            ActiveLayer& layer = layers_[i];
563
564            // point head of chain to the first layer
565            if (i == 0)
566                get_instance_proc_addr_ = layer.ref.GetGetInstanceProcAddr();
567
568            // point tail of chain to the driver
569            if (i == layer_count_ - 1) {
570                layer.instance_link.pNext = nullptr;
571                layer.instance_link.pfnNextGetInstanceProcAddr =
572                    driver::GetInstanceProcAddr;
573                break;
574            }
575
576            const ActiveLayer& next = layers_[i + 1];
577
578            // const_cast as some naughty layers want to modify our links!
579            layer.instance_link.pNext =
580                const_cast<VkLayerInstanceLink*>(&next.instance_link);
581            layer.instance_link.pfnNextGetInstanceProcAddr =
582                next.ref.GetGetInstanceProcAddr();
583        }
584    } else {
585        for (uint32_t i = 0; i < layer_count_; i++) {
586            ActiveLayer& layer = layers_[i];
587
588            // point head of chain to the first layer
589            if (i == 0) {
590                get_instance_proc_addr_ = layer.ref.GetGetInstanceProcAddr();
591                get_device_proc_addr_ = layer.ref.GetGetDeviceProcAddr();
592            }
593
594            // point tail of chain to the driver
595            if (i == layer_count_ - 1) {
596                layer.device_link.pNext = nullptr;
597                layer.device_link.pfnNextGetInstanceProcAddr =
598                    driver::GetInstanceProcAddr;
599                layer.device_link.pfnNextGetDeviceProcAddr =
600                    driver::GetDeviceProcAddr;
601                break;
602            }
603
604            const ActiveLayer& next = layers_[i + 1];
605
606            // const_cast as some naughty layers want to modify our links!
607            layer.device_link.pNext =
608                const_cast<VkLayerDeviceLink*>(&next.device_link);
609            layer.device_link.pfnNextGetInstanceProcAddr =
610                next.ref.GetGetInstanceProcAddr();
611            layer.device_link.pfnNextGetDeviceProcAddr =
612                next.ref.GetGetDeviceProcAddr();
613        }
614    }
615}
616
617bool LayerChain::Empty() const {
618    return (!layer_count_ && !override_layers_.Count() &&
619            !override_extensions_.Count());
620}
621
622void LayerChain::ModifyCreateInfo(VkInstanceCreateInfo& info) {
623    if (layer_count_) {
624        auto& link_info = instance_chain_info_[1];
625        link_info.sType = VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO;
626        link_info.pNext = info.pNext;
627        link_info.function = VK_LAYER_FUNCTION_LINK;
628        link_info.u.pLayerInfo = &layers_[0].instance_link;
629
630        auto& cb_info = instance_chain_info_[0];
631        cb_info.sType = VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO;
632        cb_info.pNext = &link_info;
633        cb_info.function = VK_LAYER_FUNCTION_DATA_CALLBACK;
634        cb_info.u.pfnSetInstanceLoaderData = SetInstanceLoaderData;
635
636        info.pNext = &cb_info;
637    }
638
639    if (override_layers_.Count()) {
640        info.enabledLayerCount = override_layers_.Count();
641        info.ppEnabledLayerNames = override_layers_.Names();
642    }
643
644    if (override_extensions_.Count()) {
645        info.enabledExtensionCount = override_extensions_.Count();
646        info.ppEnabledExtensionNames = override_extensions_.Names();
647    }
648}
649
650void LayerChain::ModifyCreateInfo(VkDeviceCreateInfo& info) {
651    if (layer_count_) {
652        auto& link_info = device_chain_info_[1];
653        link_info.sType = VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO;
654        link_info.pNext = info.pNext;
655        link_info.function = VK_LAYER_FUNCTION_LINK;
656        link_info.u.pLayerInfo = &layers_[0].device_link;
657
658        auto& cb_info = device_chain_info_[0];
659        cb_info.sType = VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO;
660        cb_info.pNext = &link_info;
661        cb_info.function = VK_LAYER_FUNCTION_DATA_CALLBACK;
662        cb_info.u.pfnSetDeviceLoaderData = SetDeviceLoaderData;
663
664        info.pNext = &cb_info;
665    }
666
667    if (override_layers_.Count()) {
668        info.enabledLayerCount = override_layers_.Count();
669        info.ppEnabledLayerNames = override_layers_.Names();
670    }
671
672    if (override_extensions_.Count()) {
673        info.enabledExtensionCount = override_extensions_.Count();
674        info.ppEnabledExtensionNames = override_extensions_.Names();
675    }
676}
677
678VkResult LayerChain::Create(const VkInstanceCreateInfo* create_info,
679                            const VkAllocationCallbacks* allocator,
680                            VkInstance* instance_out) {
681    VkResult result = ValidateExtensions(create_info->ppEnabledExtensionNames,
682                                         create_info->enabledExtensionCount);
683    if (result != VK_SUCCESS)
684        return result;
685
686    // call down the chain
687    PFN_vkCreateInstance create_instance =
688        reinterpret_cast<PFN_vkCreateInstance>(
689            get_instance_proc_addr_(VK_NULL_HANDLE, "vkCreateInstance"));
690    VkInstance instance;
691    result = create_instance(create_info, allocator, &instance);
692    if (result != VK_SUCCESS)
693        return result;
694
695    // initialize InstanceData
696    InstanceData& data = GetData(instance);
697    memset(&data, 0, sizeof(data));
698
699    data.instance = instance;
700
701    if (!InitDispatchTable(instance, get_instance_proc_addr_)) {
702        if (data.dispatch.DestroyInstance)
703            data.dispatch.DestroyInstance(instance, allocator);
704
705        return VK_ERROR_INITIALIZATION_FAILED;
706    }
707
708    // install debug report callback
709    if (override_extensions_.InstallDebugCallback()) {
710        PFN_vkCreateDebugReportCallbackEXT create_debug_report_callback =
711            reinterpret_cast<PFN_vkCreateDebugReportCallbackEXT>(
712                get_instance_proc_addr_(instance,
713                                        "vkCreateDebugReportCallbackEXT"));
714        data.destroy_debug_callback =
715            reinterpret_cast<PFN_vkDestroyDebugReportCallbackEXT>(
716                get_instance_proc_addr_(instance,
717                                        "vkDestroyDebugReportCallbackEXT"));
718        if (!create_debug_report_callback || !data.destroy_debug_callback) {
719            ALOGE("Broken VK_EXT_debug_report support");
720            data.dispatch.DestroyInstance(instance, allocator);
721            return VK_ERROR_INITIALIZATION_FAILED;
722        }
723
724        VkDebugReportCallbackCreateInfoEXT debug_callback_info = {};
725        debug_callback_info.sType =
726            VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;
727        debug_callback_info.flags =
728            VK_DEBUG_REPORT_ERROR_BIT_EXT | VK_DEBUG_REPORT_WARNING_BIT_EXT;
729        debug_callback_info.pfnCallback = DebugReportCallback;
730
731        VkDebugReportCallbackEXT debug_callback;
732        result = create_debug_report_callback(instance, &debug_callback_info,
733                                              nullptr, &debug_callback);
734        if (result != VK_SUCCESS) {
735            ALOGE("Failed to install debug report callback");
736            data.dispatch.DestroyInstance(instance, allocator);
737            return VK_ERROR_INITIALIZATION_FAILED;
738        }
739
740        data.debug_callback = debug_callback;
741
742        ALOGI("Installed debug report callback");
743    }
744
745    StealLayers(data);
746
747    *instance_out = instance;
748
749    return VK_SUCCESS;
750}
751
752VkResult LayerChain::Create(VkPhysicalDevice physical_dev,
753                            const VkDeviceCreateInfo* create_info,
754                            const VkAllocationCallbacks* allocator,
755                            VkDevice* dev_out) {
756    VkResult result =
757        ValidateExtensions(physical_dev, create_info->ppEnabledExtensionNames,
758                           create_info->enabledExtensionCount);
759    if (result != VK_SUCCESS)
760        return result;
761
762    // call down the chain
763    //
764    // TODO Instance call chain available at
765    // GetData(physical_dev).dispatch.CreateDevice is ignored.  Is that
766    // right?
767    VkInstance instance = GetData(physical_dev).instance;
768    PFN_vkCreateDevice create_device = reinterpret_cast<PFN_vkCreateDevice>(
769        get_instance_proc_addr_(instance, "vkCreateDevice"));
770    VkDevice dev;
771    result = create_device(physical_dev, create_info, allocator, &dev);
772    if (result != VK_SUCCESS)
773        return result;
774
775    // initialize DeviceData
776    DeviceData& data = GetData(dev);
777    memset(&data, 0, sizeof(data));
778
779    if (!InitDispatchTable(dev, get_device_proc_addr_)) {
780        if (data.dispatch.DestroyDevice)
781            data.dispatch.DestroyDevice(dev, allocator);
782
783        return VK_ERROR_INITIALIZATION_FAILED;
784    }
785
786    StealLayers(data);
787
788    *dev_out = dev;
789
790    return VK_SUCCESS;
791}
792
793VkResult LayerChain::ValidateExtensions(const char* const* extension_names,
794                                        uint32_t extension_count) {
795    if (!extension_count)
796        return VK_SUCCESS;
797
798    // query driver instance extensions
799    uint32_t count;
800    VkResult result =
801        EnumerateInstanceExtensionProperties(nullptr, &count, nullptr);
802    if (result == VK_SUCCESS && count) {
803        driver_extensions_ = AllocateDriverExtensionArray(count);
804        result = (driver_extensions_) ? EnumerateInstanceExtensionProperties(
805                                            nullptr, &count, driver_extensions_)
806                                      : VK_ERROR_OUT_OF_HOST_MEMORY;
807    }
808    if (result != VK_SUCCESS)
809        return result;
810
811    driver_extension_count_ = count;
812
813    for (uint32_t i = 0; i < extension_count; i++) {
814        const char* name = extension_names[i];
815        if (!IsLayerExtension(name) && !IsDriverExtension(name)) {
816            ALOGE("Failed to enable missing instance extension %s", name);
817            return VK_ERROR_EXTENSION_NOT_PRESENT;
818        }
819    }
820
821    return VK_SUCCESS;
822}
823
824VkResult LayerChain::ValidateExtensions(VkPhysicalDevice physical_dev,
825                                        const char* const* extension_names,
826                                        uint32_t extension_count) {
827    if (!extension_count)
828        return VK_SUCCESS;
829
830    // query driver device extensions
831    uint32_t count;
832    VkResult result = EnumerateDeviceExtensionProperties(physical_dev, nullptr,
833                                                         &count, nullptr);
834    if (result == VK_SUCCESS && count) {
835        driver_extensions_ = AllocateDriverExtensionArray(count);
836        result = (driver_extensions_)
837                     ? EnumerateDeviceExtensionProperties(
838                           physical_dev, nullptr, &count, driver_extensions_)
839                     : VK_ERROR_OUT_OF_HOST_MEMORY;
840    }
841    if (result != VK_SUCCESS)
842        return result;
843
844    driver_extension_count_ = count;
845
846    for (uint32_t i = 0; i < extension_count; i++) {
847        const char* name = extension_names[i];
848        if (!IsLayerExtension(name) && !IsDriverExtension(name)) {
849            ALOGE("Failed to enable missing device extension %s", name);
850            return VK_ERROR_EXTENSION_NOT_PRESENT;
851        }
852    }
853
854    return VK_SUCCESS;
855}
856
857VkExtensionProperties* LayerChain::AllocateDriverExtensionArray(
858    uint32_t count) const {
859    return reinterpret_cast<VkExtensionProperties*>(allocator_.pfnAllocation(
860        allocator_.pUserData, sizeof(VkExtensionProperties) * count,
861        alignof(VkExtensionProperties), VK_SYSTEM_ALLOCATION_SCOPE_COMMAND));
862}
863
864bool LayerChain::IsLayerExtension(const char* name) const {
865    for (uint32_t i = 0; i < layer_count_; i++) {
866        const ActiveLayer& layer = layers_[i];
867        if (layer.ref.SupportsExtension(name))
868            return true;
869    }
870
871    return false;
872}
873
874bool LayerChain::IsDriverExtension(const char* name) const {
875    for (uint32_t i = 0; i < driver_extension_count_; i++) {
876        if (strcmp(driver_extensions_[i].extensionName, name) == 0)
877            return true;
878    }
879
880    return false;
881}
882
883template <typename DataType>
884void LayerChain::StealLayers(DataType& data) {
885    data.layers = layers_;
886    data.layer_count = layer_count_;
887
888    layers_ = nullptr;
889    layer_count_ = 0;
890}
891
892void LayerChain::DestroyLayers(ActiveLayer* layers,
893                               uint32_t count,
894                               const VkAllocationCallbacks& allocator) {
895    for (uint32_t i = 0; i < count; i++)
896        layers[i].ref.~LayerRef();
897
898    allocator.pfnFree(allocator.pUserData, layers);
899}
900
901VkResult LayerChain::SetInstanceLoaderData(VkInstance instance, void* object) {
902    driver::InstanceDispatchable dispatchable =
903        reinterpret_cast<driver::InstanceDispatchable>(object);
904
905    return (driver::SetDataInternal(dispatchable, &driver::GetData(instance)))
906               ? VK_SUCCESS
907               : VK_ERROR_INITIALIZATION_FAILED;
908}
909
910VkResult LayerChain::SetDeviceLoaderData(VkDevice device, void* object) {
911    driver::DeviceDispatchable dispatchable =
912        reinterpret_cast<driver::DeviceDispatchable>(object);
913
914    return (driver::SetDataInternal(dispatchable, &driver::GetData(device)))
915               ? VK_SUCCESS
916               : VK_ERROR_INITIALIZATION_FAILED;
917}
918
919VkBool32 LayerChain::DebugReportCallback(VkDebugReportFlagsEXT flags,
920                                         VkDebugReportObjectTypeEXT obj_type,
921                                         uint64_t obj,
922                                         size_t location,
923                                         int32_t msg_code,
924                                         const char* layer_prefix,
925                                         const char* msg,
926                                         void* user_data) {
927    int prio;
928
929    if (flags & VK_DEBUG_REPORT_ERROR_BIT_EXT)
930        prio = ANDROID_LOG_ERROR;
931    else if (flags & (VK_DEBUG_REPORT_WARNING_BIT_EXT |
932                      VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT))
933        prio = ANDROID_LOG_WARN;
934    else if (flags & VK_DEBUG_REPORT_INFORMATION_BIT_EXT)
935        prio = ANDROID_LOG_INFO;
936    else if (flags & VK_DEBUG_REPORT_DEBUG_BIT_EXT)
937        prio = ANDROID_LOG_DEBUG;
938    else
939        prio = ANDROID_LOG_UNKNOWN;
940
941    LOG_PRI(prio, LOG_TAG, "[%s] Code %d : %s", layer_prefix, msg_code, msg);
942
943    (void)obj_type;
944    (void)obj;
945    (void)location;
946    (void)user_data;
947
948    return false;
949}
950
951VkResult LayerChain::CreateInstance(const VkInstanceCreateInfo* create_info,
952                                    const VkAllocationCallbacks* allocator,
953                                    VkInstance* instance_out) {
954    LayerChain chain(true,
955                     (allocator) ? *allocator : driver::GetDefaultAllocator());
956
957    VkResult result = chain.ActivateLayers(create_info->ppEnabledLayerNames,
958                                           create_info->enabledLayerCount,
959                                           create_info->ppEnabledExtensionNames,
960                                           create_info->enabledExtensionCount);
961    if (result != VK_SUCCESS)
962        return result;
963
964    // use a local create info when the chain is not empty
965    VkInstanceCreateInfo local_create_info;
966    if (!chain.Empty()) {
967        local_create_info = *create_info;
968        chain.ModifyCreateInfo(local_create_info);
969        create_info = &local_create_info;
970    }
971
972    return chain.Create(create_info, allocator, instance_out);
973}
974
975VkResult LayerChain::CreateDevice(VkPhysicalDevice physical_dev,
976                                  const VkDeviceCreateInfo* create_info,
977                                  const VkAllocationCallbacks* allocator,
978                                  VkDevice* dev_out) {
979    LayerChain chain(false, (allocator)
980                                ? *allocator
981                                : driver::GetData(physical_dev).allocator);
982
983    VkResult result = chain.ActivateLayers(create_info->ppEnabledLayerNames,
984                                           create_info->enabledLayerCount,
985                                           create_info->ppEnabledExtensionNames,
986                                           create_info->enabledExtensionCount);
987    if (result != VK_SUCCESS)
988        return result;
989
990    // use a local create info when the chain is not empty
991    VkDeviceCreateInfo local_create_info;
992    if (!chain.Empty()) {
993        local_create_info = *create_info;
994        chain.ModifyCreateInfo(local_create_info);
995        create_info = &local_create_info;
996    }
997
998    return chain.Create(physical_dev, create_info, allocator, dev_out);
999}
1000
1001void LayerChain::DestroyInstance(VkInstance instance,
1002                                 const VkAllocationCallbacks* allocator) {
1003    InstanceData& data = GetData(instance);
1004
1005    if (data.debug_callback != VK_NULL_HANDLE)
1006        data.destroy_debug_callback(instance, data.debug_callback, allocator);
1007
1008    ActiveLayer* layers = reinterpret_cast<ActiveLayer*>(data.layers);
1009    uint32_t layer_count = data.layer_count;
1010
1011    VkAllocationCallbacks local_allocator;
1012    if (!allocator)
1013        local_allocator = driver::GetData(instance).allocator;
1014
1015    // this also destroys InstanceData
1016    data.dispatch.DestroyInstance(instance, allocator);
1017
1018    DestroyLayers(layers, layer_count,
1019                  (allocator) ? *allocator : local_allocator);
1020}
1021
1022void LayerChain::DestroyDevice(VkDevice device,
1023                               const VkAllocationCallbacks* allocator) {
1024    DeviceData& data = GetData(device);
1025
1026    ActiveLayer* layers = reinterpret_cast<ActiveLayer*>(data.layers);
1027    uint32_t layer_count = data.layer_count;
1028
1029    VkAllocationCallbacks local_allocator;
1030    if (!allocator)
1031        local_allocator = driver::GetData(device).allocator;
1032
1033    // this also destroys DeviceData
1034    data.dispatch.DestroyDevice(device, allocator);
1035
1036    DestroyLayers(layers, layer_count,
1037                  (allocator) ? *allocator : local_allocator);
1038}
1039
1040// ----------------------------------------------------------------------------
1041
1042bool EnsureInitialized() {
1043    static std::once_flag once_flag;
1044    static bool initialized;
1045
1046    std::call_once(once_flag, []() {
1047        if (driver::OpenHAL()) {
1048            DiscoverLayers();
1049            initialized = true;
1050        }
1051    });
1052
1053    return initialized;
1054}
1055
1056}  // anonymous namespace
1057
1058VkResult CreateInstance(const VkInstanceCreateInfo* pCreateInfo,
1059                        const VkAllocationCallbacks* pAllocator,
1060                        VkInstance* pInstance) {
1061    if (!EnsureInitialized())
1062        return VK_ERROR_INITIALIZATION_FAILED;
1063
1064    return LayerChain::CreateInstance(pCreateInfo, pAllocator, pInstance);
1065}
1066
1067void DestroyInstance(VkInstance instance,
1068                     const VkAllocationCallbacks* pAllocator) {
1069    if (instance != VK_NULL_HANDLE)
1070        LayerChain::DestroyInstance(instance, pAllocator);
1071}
1072
1073VkResult CreateDevice(VkPhysicalDevice physicalDevice,
1074                      const VkDeviceCreateInfo* pCreateInfo,
1075                      const VkAllocationCallbacks* pAllocator,
1076                      VkDevice* pDevice) {
1077    return LayerChain::CreateDevice(physicalDevice, pCreateInfo, pAllocator,
1078                                    pDevice);
1079}
1080
1081void DestroyDevice(VkDevice device, const VkAllocationCallbacks* pAllocator) {
1082    if (device != VK_NULL_HANDLE)
1083        LayerChain::DestroyDevice(device, pAllocator);
1084}
1085
1086VkResult EnumerateInstanceLayerProperties(uint32_t* pPropertyCount,
1087                                          VkLayerProperties* pProperties) {
1088    if (!EnsureInitialized())
1089        return VK_ERROR_INITIALIZATION_FAILED;
1090
1091    uint32_t count =
1092        EnumerateInstanceLayers(pProperties ? *pPropertyCount : 0, pProperties);
1093
1094    if (!pProperties || *pPropertyCount > count)
1095        *pPropertyCount = count;
1096
1097    return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1098}
1099
1100VkResult EnumerateInstanceExtensionProperties(
1101    const char* pLayerName,
1102    uint32_t* pPropertyCount,
1103    VkExtensionProperties* pProperties) {
1104    if (!EnsureInitialized())
1105        return VK_ERROR_INITIALIZATION_FAILED;
1106
1107    if (pLayerName) {
1108        const VkExtensionProperties* props;
1109        uint32_t count;
1110        GetInstanceLayerExtensions(pLayerName, &props, &count);
1111
1112        if (!pProperties || *pPropertyCount > count)
1113            *pPropertyCount = count;
1114        if (pProperties)
1115            std::copy(props, props + *pPropertyCount, pProperties);
1116
1117        return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1118    }
1119
1120    // TODO how about extensions from implicitly enabled layers?
1121    return vulkan::driver::EnumerateInstanceExtensionProperties(
1122        nullptr, pPropertyCount, pProperties);
1123}
1124
1125VkResult EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
1126                                        uint32_t* pPropertyCount,
1127                                        VkLayerProperties* pProperties) {
1128    (void)physicalDevice;
1129
1130    uint32_t count =
1131        EnumerateDeviceLayers(pProperties ? *pPropertyCount : 0, pProperties);
1132
1133    if (!pProperties || *pPropertyCount > count)
1134        *pPropertyCount = count;
1135
1136    return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1137}
1138
1139VkResult EnumerateDeviceExtensionProperties(
1140    VkPhysicalDevice physicalDevice,
1141    const char* pLayerName,
1142    uint32_t* pPropertyCount,
1143    VkExtensionProperties* pProperties) {
1144    if (pLayerName) {
1145        const VkExtensionProperties* props;
1146        uint32_t count;
1147        GetDeviceLayerExtensions(pLayerName, &props, &count);
1148
1149        if (!pProperties || *pPropertyCount > count)
1150            *pPropertyCount = count;
1151        if (pProperties)
1152            std::copy(props, props + *pPropertyCount, pProperties);
1153
1154        return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1155    }
1156
1157    // TODO how about extensions from implicitly enabled layers?
1158    const InstanceData& data = GetData(physicalDevice);
1159    return data.dispatch.EnumerateDeviceExtensionProperties(
1160        physicalDevice, nullptr, pPropertyCount, pProperties);
1161}
1162
1163}  // namespace api
1164}  // namespace vulkan
1165