api.cpp revision 8925efd0a87d96885834a00f3bdef220edf6d8ea 
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    std::bitset<driver::ProcHook::EXTENSION_COUNT> enabled_extensions_;
469};
470
471LayerChain::LayerChain(bool is_instance, const VkAllocationCallbacks& allocator)
472    : is_instance_(is_instance),
473      allocator_(allocator),
474      override_layers_(is_instance, allocator),
475      override_extensions_(is_instance, allocator),
476      layers_(nullptr),
477      layer_count_(0),
478      get_instance_proc_addr_(nullptr),
479      get_device_proc_addr_(nullptr),
480      driver_extensions_(nullptr),
481      driver_extension_count_(0) {
482    enabled_extensions_.set(driver::ProcHook::EXTENSION_CORE);
483}
484
485LayerChain::~LayerChain() {
486    allocator_.pfnFree(allocator_.pUserData, driver_extensions_);
487    DestroyLayers(layers_, layer_count_, allocator_);
488}
489
490VkResult LayerChain::ActivateLayers(const char* const* layer_names,
491                                    uint32_t layer_count,
492                                    const char* const* extension_names,
493                                    uint32_t extension_count) {
494    VkResult result = override_layers_.Parse(layer_names, layer_count);
495    if (result != VK_SUCCESS)
496        return result;
497
498    result = override_extensions_.Parse(extension_names, extension_count);
499    if (result != VK_SUCCESS)
500        return result;
501
502    if (override_layers_.Count()) {
503        layer_names = override_layers_.Names();
504        layer_count = override_layers_.Count();
505    }
506
507    if (!layer_count) {
508        // point head of chain to the driver
509        get_instance_proc_addr_ = driver::GetInstanceProcAddr;
510        if (!is_instance_)
511            get_device_proc_addr_ = driver::GetDeviceProcAddr;
512
513        return VK_SUCCESS;
514    }
515
516    layers_ = AllocateLayerArray(layer_count);
517    if (!layers_)
518        return VK_ERROR_OUT_OF_HOST_MEMORY;
519
520    // load layers
521    for (uint32_t i = 0; i < layer_count; i++) {
522        result = LoadLayer(layers_[i], layer_names[i]);
523        if (result != VK_SUCCESS)
524            return result;
525
526        // count loaded layers for proper destructions on errors
527        layer_count_++;
528    }
529
530    SetupLayerLinks();
531
532    return VK_SUCCESS;
533}
534
535LayerChain::ActiveLayer* LayerChain::AllocateLayerArray(uint32_t count) const {
536    VkSystemAllocationScope scope = (is_instance_)
537                                        ? VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE
538                                        : VK_SYSTEM_ALLOCATION_SCOPE_DEVICE;
539
540    return reinterpret_cast<ActiveLayer*>(allocator_.pfnAllocation(
541        allocator_.pUserData, sizeof(ActiveLayer) * count, alignof(ActiveLayer),
542        scope));
543}
544
545VkResult LayerChain::LoadLayer(ActiveLayer& layer, const char* name) {
546    if (is_instance_)
547        new (&layer) ActiveLayer{GetInstanceLayerRef(name), {}};
548    else
549        new (&layer) ActiveLayer{GetDeviceLayerRef(name), {}};
550
551    if (!layer.ref) {
552        ALOGE("Failed to load layer %s", name);
553        layer.ref.~LayerRef();
554        return VK_ERROR_LAYER_NOT_PRESENT;
555    }
556
557    ALOGI("Loaded %s layer %s", (is_instance_) ? "instance" : "device", name);
558
559    return VK_SUCCESS;
560}
561
562void LayerChain::SetupLayerLinks() {
563    if (is_instance_) {
564        for (uint32_t i = 0; i < layer_count_; i++) {
565            ActiveLayer& layer = layers_[i];
566
567            // point head of chain to the first layer
568            if (i == 0)
569                get_instance_proc_addr_ = layer.ref.GetGetInstanceProcAddr();
570
571            // point tail of chain to the driver
572            if (i == layer_count_ - 1) {
573                layer.instance_link.pNext = nullptr;
574                layer.instance_link.pfnNextGetInstanceProcAddr =
575                    driver::GetInstanceProcAddr;
576                break;
577            }
578
579            const ActiveLayer& next = layers_[i + 1];
580
581            // const_cast as some naughty layers want to modify our links!
582            layer.instance_link.pNext =
583                const_cast<VkLayerInstanceLink*>(&next.instance_link);
584            layer.instance_link.pfnNextGetInstanceProcAddr =
585                next.ref.GetGetInstanceProcAddr();
586        }
587    } else {
588        for (uint32_t i = 0; i < layer_count_; i++) {
589            ActiveLayer& layer = layers_[i];
590
591            // point head of chain to the first layer
592            if (i == 0) {
593                get_instance_proc_addr_ = layer.ref.GetGetInstanceProcAddr();
594                get_device_proc_addr_ = layer.ref.GetGetDeviceProcAddr();
595            }
596
597            // point tail of chain to the driver
598            if (i == layer_count_ - 1) {
599                layer.device_link.pNext = nullptr;
600                layer.device_link.pfnNextGetInstanceProcAddr =
601                    driver::GetInstanceProcAddr;
602                layer.device_link.pfnNextGetDeviceProcAddr =
603                    driver::GetDeviceProcAddr;
604                break;
605            }
606
607            const ActiveLayer& next = layers_[i + 1];
608
609            // const_cast as some naughty layers want to modify our links!
610            layer.device_link.pNext =
611                const_cast<VkLayerDeviceLink*>(&next.device_link);
612            layer.device_link.pfnNextGetInstanceProcAddr =
613                next.ref.GetGetInstanceProcAddr();
614            layer.device_link.pfnNextGetDeviceProcAddr =
615                next.ref.GetGetDeviceProcAddr();
616        }
617    }
618}
619
620bool LayerChain::Empty() const {
621    return (!layer_count_ && !override_layers_.Count() &&
622            !override_extensions_.Count());
623}
624
625void LayerChain::ModifyCreateInfo(VkInstanceCreateInfo& info) {
626    if (layer_count_) {
627        auto& link_info = instance_chain_info_[1];
628        link_info.sType = VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO;
629        link_info.pNext = info.pNext;
630        link_info.function = VK_LAYER_FUNCTION_LINK;
631        link_info.u.pLayerInfo = &layers_[0].instance_link;
632
633        auto& cb_info = instance_chain_info_[0];
634        cb_info.sType = VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO;
635        cb_info.pNext = &link_info;
636        cb_info.function = VK_LAYER_FUNCTION_DATA_CALLBACK;
637        cb_info.u.pfnSetInstanceLoaderData = SetInstanceLoaderData;
638
639        info.pNext = &cb_info;
640    }
641
642    if (override_layers_.Count()) {
643        info.enabledLayerCount = override_layers_.Count();
644        info.ppEnabledLayerNames = override_layers_.Names();
645    }
646
647    if (override_extensions_.Count()) {
648        info.enabledExtensionCount = override_extensions_.Count();
649        info.ppEnabledExtensionNames = override_extensions_.Names();
650    }
651}
652
653void LayerChain::ModifyCreateInfo(VkDeviceCreateInfo& info) {
654    if (layer_count_) {
655        auto& link_info = device_chain_info_[1];
656        link_info.sType = VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO;
657        link_info.pNext = info.pNext;
658        link_info.function = VK_LAYER_FUNCTION_LINK;
659        link_info.u.pLayerInfo = &layers_[0].device_link;
660
661        auto& cb_info = device_chain_info_[0];
662        cb_info.sType = VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO;
663        cb_info.pNext = &link_info;
664        cb_info.function = VK_LAYER_FUNCTION_DATA_CALLBACK;
665        cb_info.u.pfnSetDeviceLoaderData = SetDeviceLoaderData;
666
667        info.pNext = &cb_info;
668    }
669
670    if (override_layers_.Count()) {
671        info.enabledLayerCount = override_layers_.Count();
672        info.ppEnabledLayerNames = override_layers_.Names();
673    }
674
675    if (override_extensions_.Count()) {
676        info.enabledExtensionCount = override_extensions_.Count();
677        info.ppEnabledExtensionNames = override_extensions_.Names();
678    }
679}
680
681VkResult LayerChain::Create(const VkInstanceCreateInfo* create_info,
682                            const VkAllocationCallbacks* allocator,
683                            VkInstance* instance_out) {
684    VkResult result = ValidateExtensions(create_info->ppEnabledExtensionNames,
685                                         create_info->enabledExtensionCount);
686    if (result != VK_SUCCESS)
687        return result;
688
689    // call down the chain
690    PFN_vkCreateInstance create_instance =
691        reinterpret_cast<PFN_vkCreateInstance>(
692            get_instance_proc_addr_(VK_NULL_HANDLE, "vkCreateInstance"));
693    VkInstance instance;
694    result = create_instance(create_info, allocator, &instance);
695    if (result != VK_SUCCESS)
696        return result;
697
698    // initialize InstanceData
699    InstanceData& data = GetData(instance);
700
701    data.instance = instance;
702
703    if (!InitDispatchTable(instance, get_instance_proc_addr_,
704                           enabled_extensions_)) {
705        if (data.dispatch.DestroyInstance)
706            data.dispatch.DestroyInstance(instance, allocator);
707
708        return VK_ERROR_INITIALIZATION_FAILED;
709    }
710
711    // install debug report callback
712    if (override_extensions_.InstallDebugCallback()) {
713        PFN_vkCreateDebugReportCallbackEXT create_debug_report_callback =
714            reinterpret_cast<PFN_vkCreateDebugReportCallbackEXT>(
715                get_instance_proc_addr_(instance,
716                                        "vkCreateDebugReportCallbackEXT"));
717        data.destroy_debug_callback =
718            reinterpret_cast<PFN_vkDestroyDebugReportCallbackEXT>(
719                get_instance_proc_addr_(instance,
720                                        "vkDestroyDebugReportCallbackEXT"));
721        if (!create_debug_report_callback || !data.destroy_debug_callback) {
722            ALOGE("Broken VK_EXT_debug_report support");
723            data.dispatch.DestroyInstance(instance, allocator);
724            return VK_ERROR_INITIALIZATION_FAILED;
725        }
726
727        VkDebugReportCallbackCreateInfoEXT debug_callback_info = {};
728        debug_callback_info.sType =
729            VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;
730        debug_callback_info.flags =
731            VK_DEBUG_REPORT_ERROR_BIT_EXT | VK_DEBUG_REPORT_WARNING_BIT_EXT;
732        debug_callback_info.pfnCallback = DebugReportCallback;
733
734        VkDebugReportCallbackEXT debug_callback;
735        result = create_debug_report_callback(instance, &debug_callback_info,
736                                              nullptr, &debug_callback);
737        if (result != VK_SUCCESS) {
738            ALOGE("Failed to install debug report callback");
739            data.dispatch.DestroyInstance(instance, allocator);
740            return VK_ERROR_INITIALIZATION_FAILED;
741        }
742
743        data.debug_callback = debug_callback;
744
745        ALOGI("Installed debug report callback");
746    }
747
748    StealLayers(data);
749
750    *instance_out = instance;
751
752    return VK_SUCCESS;
753}
754
755VkResult LayerChain::Create(VkPhysicalDevice physical_dev,
756                            const VkDeviceCreateInfo* create_info,
757                            const VkAllocationCallbacks* allocator,
758                            VkDevice* dev_out) {
759    VkResult result =
760        ValidateExtensions(physical_dev, create_info->ppEnabledExtensionNames,
761                           create_info->enabledExtensionCount);
762    if (result != VK_SUCCESS)
763        return result;
764
765    // call down the chain
766    //
767    // TODO Instance call chain available at
768    // GetData(physical_dev).dispatch.CreateDevice is ignored.  Is that
769    // right?
770    VkInstance instance = GetData(physical_dev).instance;
771    PFN_vkCreateDevice create_device = reinterpret_cast<PFN_vkCreateDevice>(
772        get_instance_proc_addr_(instance, "vkCreateDevice"));
773    VkDevice dev;
774    result = create_device(physical_dev, create_info, allocator, &dev);
775    if (result != VK_SUCCESS)
776        return result;
777
778    // initialize DeviceData
779    DeviceData& data = GetData(dev);
780
781    if (!InitDispatchTable(dev, get_device_proc_addr_, enabled_extensions_)) {
782        if (data.dispatch.DestroyDevice)
783            data.dispatch.DestroyDevice(dev, allocator);
784
785        return VK_ERROR_INITIALIZATION_FAILED;
786    }
787
788    StealLayers(data);
789
790    *dev_out = dev;
791
792    return VK_SUCCESS;
793}
794
795VkResult LayerChain::ValidateExtensions(const char* const* extension_names,
796                                        uint32_t extension_count) {
797    if (!extension_count)
798        return VK_SUCCESS;
799
800    // query driver instance extensions
801    uint32_t count;
802    VkResult result =
803        EnumerateInstanceExtensionProperties(nullptr, &count, nullptr);
804    if (result == VK_SUCCESS && count) {
805        driver_extensions_ = AllocateDriverExtensionArray(count);
806        result = (driver_extensions_) ? EnumerateInstanceExtensionProperties(
807                                            nullptr, &count, driver_extensions_)
808                                      : VK_ERROR_OUT_OF_HOST_MEMORY;
809    }
810    if (result != VK_SUCCESS)
811        return result;
812
813    driver_extension_count_ = count;
814
815    for (uint32_t i = 0; i < extension_count; i++) {
816        const char* name = extension_names[i];
817        if (!IsLayerExtension(name) && !IsDriverExtension(name)) {
818            ALOGE("Failed to enable missing instance extension %s", name);
819            return VK_ERROR_EXTENSION_NOT_PRESENT;
820        }
821
822        auto ext_bit = driver::GetProcHookExtension(name);
823        if (ext_bit != driver::ProcHook::EXTENSION_UNKNOWN)
824            enabled_extensions_.set(ext_bit);
825    }
826
827    return VK_SUCCESS;
828}
829
830VkResult LayerChain::ValidateExtensions(VkPhysicalDevice physical_dev,
831                                        const char* const* extension_names,
832                                        uint32_t extension_count) {
833    if (!extension_count)
834        return VK_SUCCESS;
835
836    // query driver device extensions
837    uint32_t count;
838    VkResult result = EnumerateDeviceExtensionProperties(physical_dev, nullptr,
839                                                         &count, nullptr);
840    if (result == VK_SUCCESS && count) {
841        driver_extensions_ = AllocateDriverExtensionArray(count);
842        result = (driver_extensions_)
843                     ? EnumerateDeviceExtensionProperties(
844                           physical_dev, nullptr, &count, driver_extensions_)
845                     : VK_ERROR_OUT_OF_HOST_MEMORY;
846    }
847    if (result != VK_SUCCESS)
848        return result;
849
850    driver_extension_count_ = count;
851
852    for (uint32_t i = 0; i < extension_count; i++) {
853        const char* name = extension_names[i];
854        if (!IsLayerExtension(name) && !IsDriverExtension(name)) {
855            ALOGE("Failed to enable missing device extension %s", name);
856            return VK_ERROR_EXTENSION_NOT_PRESENT;
857        }
858
859        auto ext_bit = driver::GetProcHookExtension(name);
860        if (ext_bit != driver::ProcHook::EXTENSION_UNKNOWN)
861            enabled_extensions_.set(ext_bit);
862    }
863
864    return VK_SUCCESS;
865}
866
867VkExtensionProperties* LayerChain::AllocateDriverExtensionArray(
868    uint32_t count) const {
869    return reinterpret_cast<VkExtensionProperties*>(allocator_.pfnAllocation(
870        allocator_.pUserData, sizeof(VkExtensionProperties) * count,
871        alignof(VkExtensionProperties), VK_SYSTEM_ALLOCATION_SCOPE_COMMAND));
872}
873
874bool LayerChain::IsLayerExtension(const char* name) const {
875    for (uint32_t i = 0; i < layer_count_; i++) {
876        const ActiveLayer& layer = layers_[i];
877        if (layer.ref.SupportsExtension(name))
878            return true;
879    }
880
881    return false;
882}
883
884bool LayerChain::IsDriverExtension(const char* name) const {
885    for (uint32_t i = 0; i < driver_extension_count_; i++) {
886        if (strcmp(driver_extensions_[i].extensionName, name) == 0)
887            return true;
888    }
889
890    return false;
891}
892
893template <typename DataType>
894void LayerChain::StealLayers(DataType& data) {
895    data.layers = layers_;
896    data.layer_count = layer_count_;
897
898    layers_ = nullptr;
899    layer_count_ = 0;
900}
901
902void LayerChain::DestroyLayers(ActiveLayer* layers,
903                               uint32_t count,
904                               const VkAllocationCallbacks& allocator) {
905    for (uint32_t i = 0; i < count; i++)
906        layers[i].ref.~LayerRef();
907
908    allocator.pfnFree(allocator.pUserData, layers);
909}
910
911VkResult LayerChain::SetInstanceLoaderData(VkInstance instance, void* object) {
912    driver::InstanceDispatchable dispatchable =
913        reinterpret_cast<driver::InstanceDispatchable>(object);
914
915    return (driver::SetDataInternal(dispatchable, &driver::GetData(instance)))
916               ? VK_SUCCESS
917               : VK_ERROR_INITIALIZATION_FAILED;
918}
919
920VkResult LayerChain::SetDeviceLoaderData(VkDevice device, void* object) {
921    driver::DeviceDispatchable dispatchable =
922        reinterpret_cast<driver::DeviceDispatchable>(object);
923
924    return (driver::SetDataInternal(dispatchable, &driver::GetData(device)))
925               ? VK_SUCCESS
926               : VK_ERROR_INITIALIZATION_FAILED;
927}
928
929VkBool32 LayerChain::DebugReportCallback(VkDebugReportFlagsEXT flags,
930                                         VkDebugReportObjectTypeEXT obj_type,
931                                         uint64_t obj,
932                                         size_t location,
933                                         int32_t msg_code,
934                                         const char* layer_prefix,
935                                         const char* msg,
936                                         void* user_data) {
937    int prio;
938
939    if (flags & VK_DEBUG_REPORT_ERROR_BIT_EXT)
940        prio = ANDROID_LOG_ERROR;
941    else if (flags & (VK_DEBUG_REPORT_WARNING_BIT_EXT |
942                      VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT))
943        prio = ANDROID_LOG_WARN;
944    else if (flags & VK_DEBUG_REPORT_INFORMATION_BIT_EXT)
945        prio = ANDROID_LOG_INFO;
946    else if (flags & VK_DEBUG_REPORT_DEBUG_BIT_EXT)
947        prio = ANDROID_LOG_DEBUG;
948    else
949        prio = ANDROID_LOG_UNKNOWN;
950
951    LOG_PRI(prio, LOG_TAG, "[%s] Code %d : %s", layer_prefix, msg_code, msg);
952
953    (void)obj_type;
954    (void)obj;
955    (void)location;
956    (void)user_data;
957
958    return false;
959}
960
961VkResult LayerChain::CreateInstance(const VkInstanceCreateInfo* create_info,
962                                    const VkAllocationCallbacks* allocator,
963                                    VkInstance* instance_out) {
964    LayerChain chain(true,
965                     (allocator) ? *allocator : driver::GetDefaultAllocator());
966
967    VkResult result = chain.ActivateLayers(create_info->ppEnabledLayerNames,
968                                           create_info->enabledLayerCount,
969                                           create_info->ppEnabledExtensionNames,
970                                           create_info->enabledExtensionCount);
971    if (result != VK_SUCCESS)
972        return result;
973
974    // use a local create info when the chain is not empty
975    VkInstanceCreateInfo local_create_info;
976    if (!chain.Empty()) {
977        local_create_info = *create_info;
978        chain.ModifyCreateInfo(local_create_info);
979        create_info = &local_create_info;
980    }
981
982    return chain.Create(create_info, allocator, instance_out);
983}
984
985VkResult LayerChain::CreateDevice(VkPhysicalDevice physical_dev,
986                                  const VkDeviceCreateInfo* create_info,
987                                  const VkAllocationCallbacks* allocator,
988                                  VkDevice* dev_out) {
989    LayerChain chain(false, (allocator)
990                                ? *allocator
991                                : driver::GetData(physical_dev).allocator);
992
993    VkResult result = chain.ActivateLayers(create_info->ppEnabledLayerNames,
994                                           create_info->enabledLayerCount,
995                                           create_info->ppEnabledExtensionNames,
996                                           create_info->enabledExtensionCount);
997    if (result != VK_SUCCESS)
998        return result;
999
1000    // use a local create info when the chain is not empty
1001    VkDeviceCreateInfo local_create_info;
1002    if (!chain.Empty()) {
1003        local_create_info = *create_info;
1004        chain.ModifyCreateInfo(local_create_info);
1005        create_info = &local_create_info;
1006    }
1007
1008    return chain.Create(physical_dev, create_info, allocator, dev_out);
1009}
1010
1011void LayerChain::DestroyInstance(VkInstance instance,
1012                                 const VkAllocationCallbacks* allocator) {
1013    InstanceData& data = GetData(instance);
1014
1015    if (data.debug_callback != VK_NULL_HANDLE)
1016        data.destroy_debug_callback(instance, data.debug_callback, allocator);
1017
1018    ActiveLayer* layers = reinterpret_cast<ActiveLayer*>(data.layers);
1019    uint32_t layer_count = data.layer_count;
1020
1021    VkAllocationCallbacks local_allocator;
1022    if (!allocator)
1023        local_allocator = driver::GetData(instance).allocator;
1024
1025    // this also destroys InstanceData
1026    data.dispatch.DestroyInstance(instance, allocator);
1027
1028    DestroyLayers(layers, layer_count,
1029                  (allocator) ? *allocator : local_allocator);
1030}
1031
1032void LayerChain::DestroyDevice(VkDevice device,
1033                               const VkAllocationCallbacks* allocator) {
1034    DeviceData& data = GetData(device);
1035
1036    ActiveLayer* layers = reinterpret_cast<ActiveLayer*>(data.layers);
1037    uint32_t layer_count = data.layer_count;
1038
1039    VkAllocationCallbacks local_allocator;
1040    if (!allocator)
1041        local_allocator = driver::GetData(device).allocator;
1042
1043    // this also destroys DeviceData
1044    data.dispatch.DestroyDevice(device, allocator);
1045
1046    DestroyLayers(layers, layer_count,
1047                  (allocator) ? *allocator : local_allocator);
1048}
1049
1050// ----------------------------------------------------------------------------
1051
1052bool EnsureInitialized() {
1053    static std::once_flag once_flag;
1054    static bool initialized;
1055
1056    std::call_once(once_flag, []() {
1057        if (driver::OpenHAL()) {
1058            DiscoverLayers();
1059            initialized = true;
1060        }
1061    });
1062
1063    return initialized;
1064}
1065
1066}  // anonymous namespace
1067
1068VkResult CreateInstance(const VkInstanceCreateInfo* pCreateInfo,
1069                        const VkAllocationCallbacks* pAllocator,
1070                        VkInstance* pInstance) {
1071    if (!EnsureInitialized())
1072        return VK_ERROR_INITIALIZATION_FAILED;
1073
1074    return LayerChain::CreateInstance(pCreateInfo, pAllocator, pInstance);
1075}
1076
1077void DestroyInstance(VkInstance instance,
1078                     const VkAllocationCallbacks* pAllocator) {
1079    if (instance != VK_NULL_HANDLE)
1080        LayerChain::DestroyInstance(instance, pAllocator);
1081}
1082
1083VkResult CreateDevice(VkPhysicalDevice physicalDevice,
1084                      const VkDeviceCreateInfo* pCreateInfo,
1085                      const VkAllocationCallbacks* pAllocator,
1086                      VkDevice* pDevice) {
1087    return LayerChain::CreateDevice(physicalDevice, pCreateInfo, pAllocator,
1088                                    pDevice);
1089}
1090
1091void DestroyDevice(VkDevice device, const VkAllocationCallbacks* pAllocator) {
1092    if (device != VK_NULL_HANDLE)
1093        LayerChain::DestroyDevice(device, pAllocator);
1094}
1095
1096VkResult EnumerateInstanceLayerProperties(uint32_t* pPropertyCount,
1097                                          VkLayerProperties* pProperties) {
1098    if (!EnsureInitialized())
1099        return VK_ERROR_INITIALIZATION_FAILED;
1100
1101    uint32_t count =
1102        EnumerateInstanceLayers(pProperties ? *pPropertyCount : 0, pProperties);
1103
1104    if (!pProperties || *pPropertyCount > count)
1105        *pPropertyCount = count;
1106
1107    return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1108}
1109
1110VkResult EnumerateInstanceExtensionProperties(
1111    const char* pLayerName,
1112    uint32_t* pPropertyCount,
1113    VkExtensionProperties* pProperties) {
1114    if (!EnsureInitialized())
1115        return VK_ERROR_INITIALIZATION_FAILED;
1116
1117    if (pLayerName) {
1118        const VkExtensionProperties* props;
1119        uint32_t count;
1120        GetInstanceLayerExtensions(pLayerName, &props, &count);
1121
1122        if (!pProperties || *pPropertyCount > count)
1123            *pPropertyCount = count;
1124        if (pProperties)
1125            std::copy(props, props + *pPropertyCount, pProperties);
1126
1127        return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1128    }
1129
1130    // TODO how about extensions from implicitly enabled layers?
1131    return vulkan::driver::EnumerateInstanceExtensionProperties(
1132        nullptr, pPropertyCount, pProperties);
1133}
1134
1135VkResult EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
1136                                        uint32_t* pPropertyCount,
1137                                        VkLayerProperties* pProperties) {
1138    (void)physicalDevice;
1139
1140    uint32_t count =
1141        EnumerateDeviceLayers(pProperties ? *pPropertyCount : 0, pProperties);
1142
1143    if (!pProperties || *pPropertyCount > count)
1144        *pPropertyCount = count;
1145
1146    return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1147}
1148
1149VkResult EnumerateDeviceExtensionProperties(
1150    VkPhysicalDevice physicalDevice,
1151    const char* pLayerName,
1152    uint32_t* pPropertyCount,
1153    VkExtensionProperties* pProperties) {
1154    if (pLayerName) {
1155        const VkExtensionProperties* props;
1156        uint32_t count;
1157        GetDeviceLayerExtensions(pLayerName, &props, &count);
1158
1159        if (!pProperties || *pPropertyCount > count)
1160            *pPropertyCount = count;
1161        if (pProperties)
1162            std::copy(props, props + *pPropertyCount, pProperties);
1163
1164        return *pPropertyCount < count ? VK_INCOMPLETE : VK_SUCCESS;
1165    }
1166
1167    // TODO how about extensions from implicitly enabled layers?
1168    const InstanceData& data = GetData(physicalDevice);
1169    return data.dispatch.EnumerateDeviceExtensionProperties(
1170        physicalDevice, nullptr, pPropertyCount, pProperties);
1171}
1172
1173}  // namespace api
1174}  // namespace vulkan
1175