Android-এ Vulkan ভ্যালিডেশন লেয়ার

বেশিরভাগ এক্সপ্লিসিট গ্রাফিক্স API সমস্যা চেক করে না কারণ এটি করলে পারফর্ম্যান্সের উপর প্রভাব পড়তে পারে। Vulkan-এ ভ্যালিডেশন লেয়ার আছে যা ডেভেলপমেন্টের সময় ত্রুটি-চেকিংয়ের সুবিধা প্রদান করে, আপনার অ্যাপের রিলিজ বিল্ডে পারফর্ম্যান্স পেনাল্টি এড়িয়ে যায়। ভ্যালিডেশন লেয়ার সাধারণ উদ্দেশ্যের লেয়ারিং মেকানিজমের উপর নির্ভর করে যা API এন্ট্রি পয়েন্ট ইন্টারসেপ্ট করে।

সিঙ্গেল Khronos ভ্যালিডেশন লেয়ার

আগে, Vulkan একাধিক ভ্যালিডেশন লেয়ার প্রদান করত যেগুলি নির্দিষ্ট ক্রমে চালু করতে হত। 1.1.106.0 Vulkan SDK রিলিজ থেকে শুরু করে, আপনার অ্যাপকে শুধুমাত্র একটি সিঙ্গেল ভ্যালিডেশন লেয়ার, VK_LAYER_KHRONOS_validation চালু করতে হবে, যাতে আগের ভ্যালিডেশন লেয়ার থেকে সব ফিচার পাওয়া যায়।

আপনার APK-তে প্যাকেজ করা ভ্যালিডেশন লেয়ার ব্যবহার করুন

আপনার APK-এর মধ্যে ভ্যালিডেশন লেয়ার প্যাকেজ করলে তা উপযুক্ত কম্প্যাটিবিলিটি নিশ্চিত করে। ভ্যালিডেশন লেয়ারগুলি প্রি-বিল্ট বাইনারি হিসেবে উপলভ্য অথবা সোর্স কোড থেকে তৈরি করা যায়।

আগে থেকে তৈরি বাইনারি ব্যবহার করুন

GitHub রিলিজ পৃষ্ঠা থেকে লেটেস্ট Android Vulkan ভ্যালিডেশন লেয়ার বাইনারি ডাউনলোড করুন।

আপনার APK-তে লেয়ার যোগ করার সবচেয়ে সহজ উপায় হল, আপনার মডিউলের src/main/jniLibs/ ডিরেক্টরিতে প্রি-বিল্ট লেয়ার বাইনারি এক্সট্র্যাক্ট করা, যেখানে ABI ডিরেক্টরি (যেমন arm64-v8a বা x86-64) অক্ষত থাকবে, যেমন:

src/main/jniLibs/
  arm64-v8a/
    libVkLayer_khronos_validation.so
  armeabi-v7a/
    libVkLayer_khronos_validation.so
  x86/
    libVkLayer_khronos_validation.so
  x86-64/
    libVkLayer_khronos_validation.so

সোর্স কোড থেকে ভ্যালিডেশন লেয়ার তৈরি করা

ভ্যালিডেশন লেয়ার সোর্স কোডে ডিবাগ করতে, Khronos Group GitHub রিপোজিটরি থেকে লেটেস্ট সোর্স পুল করুন এবং সেখানে দেওয়া বিল্ড সংক্রান্ত নির্দেশাবলী অনুসরণ করুন।

ভ্যালিডেশন লেয়ার সঠিকভাবে প্যাকেজ করা হয়েছে কিনা তা যাচাই করুন

আপনি Khronos প্রি-বিল্ট লেয়ার বা সোর্স থেকে তৈরি লেয়ারের সাহায্যে তৈরি করুন না কেন, বিল্ড প্রসেস আপনার APK-তে নিম্নলিখিত ফাইলের মতো একটি ফাইনাল ফাইল স্ট্রাকচার তৈরি করে:

lib/
  arm64-v8a/
    libVkLayer_khronos_validation.so
  armeabi-v7a/
    libVkLayer_khronos_validation.so
  x86/
    libVkLayer_khronos_validation.so
  x86-64/
    libVkLayer_khronos_validation.so

আপনার APK-তে প্রত্যাশা অনুযায়ী ভ্যালিডেশন লেয়ার আছে কিনা তা কীভাবে যাচাই করবেন তা নিম্নলিখিত কমান্ড থেকে জানতে পারবেন:

$ jar -tf project.apk | grep libVkLayer
lib/x86_64/libVkLayer_khronos_validation.so
lib/armeabi-v7a/libVkLayer_khronos_validation.so
lib/arm64-v8a/libVkLayer_khronos_validation.so
lib/x86/libVkLayer_khronos_validation.so

ইনস্ট্যান্স তৈরি করার সময় ভ্যালিডেশন লেয়ার চালু করুন

Vulkan API কোনও অ্যাপকে ইনস্ট্যান্স তৈরির সময় লেয়ার চালু করার অনুমতি দেয়। একটি লেয়ার ইন্টারসেপ্ট করে এমন এন্ট্রি পয়েন্টের প্রথম প্যারামিটার হিসেবে নিম্নলিখিত অবজেক্টগুলির মধ্যে একটি থাকতে হবে:

  • VkInstance
  • VkPhysicalDevice
  • VkDevice
  • VkCommandBuffer
  • VkQueue

উপলভ্য লেয়ার ও সেগুলির প্রপার্টি তালিকাভুক্ত করতে vkEnumerateInstanceLayerProperties() কল করুন। Vulkan লেয়ার চালু করে যখন vkCreateInstance() এক্সিকিউট করে।

নিচের কোড স্নিপেট থেকে জানা যায় যে কীভাবে কোনও অ্যাপ Vulkan API ব্যবহার করে প্রোগ্রাম্যাটিক্যালি কোয়েরি করতে এবং লেয়ার চালু করতে পারে:

// Enable just the Khronos validation layer.
static const char *layers[] = {"VK_LAYER_KHRONOS_validation"};

// Get the layer count using a null pointer as the last parameter.
uint32_t instance_layer_present_count = 0;
vkEnumerateInstanceLayerProperties(&instance_layer_present_count, nullptr);

// Enumerate layers with a valid pointer in the last parameter.
VkLayerProperties layer_props[instance_layer_present_count];
vkEnumerateInstanceLayerProperties(&instance_layer_present_count, layer_props);

// Make sure selected validation layers are available.
VkLayerProperties *layer_props_end = layer_props + instance_layer_present_count;
for (const char* layer:layers) {
  assert(layer_props_end !=
  std::find_if(layer_props, layer_props_end, [layer](VkLayerProperties layerProperties) {
    return strcmp(layerProperties.layerName, layer) == 0;
  }));
}

// Create a Vulkan instance, requesting all enabled layers or extensions
// available on the system
VkInstanceCreateInfo instanceCreateInfo{
  .sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,
  .pNext = nullptr,
  .pApplicationInfo = &appInfo,
  .enabledLayerCount = sizeof(layers) / sizeof(layers[0]),
  .ppEnabledLayerNames = layers,

ডিফল্ট logcat আউটপুট

ভ্যালিডেশন লেয়ার logcat-এ সতর্কতা ও সমস্যার মেসেজ দেখায় যা VALIDATION ট্যাগ দিয়ে লেবেল করা থাকে। ভ্যালিডেশন লেয়ার মেসেজ নিম্নলিখিত মেসেজের মতো দেখতে হয় (সহজে স্ক্রল করার জন্য এখানে লাইন ব্রেক যোগ করা হয়েছে):

Validation -- Validation Error:
  [ VUID-VkDeviceQueueCreateInfo-pQueuePriorities-parameter ]
Object 0: VK_NULL_HANDLE, type = VK_OBJECT_TYPE_DEVICE; | MessageID = 0xd6d720c6 |
vkCreateDevice: required parameter
  pCreateInfo->pQueueCreateInfos[0].pQueuePriorities specified as NULL.
The Vulkan spec states: pQueuePriorities must be a valid pointer to an array of
  queueCount float values
  (https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html
  #VUID-VkDeviceQueueCreateInfo-pQueuePriorities-parameter)

ডিবাগ কলব্যাক চালু করুন

Debug Utils এক্সটেনশন VK_EXT_debug_utils আপনার অ্যাপ্লিকেশনকে একটি ডিবাগ মেসেঞ্জার তৈরি করতে দেয় যা অ্যাপ্লিকেশন-প্রদত্ত কলব্যাকে ভ্যালিডেশন লেয়ার মেসেজ পাস করে। আপনার ডিভাইস এই এক্সটেনশন প্রয়োগ নাও করতে পারে, তবে এটি সবচেয়ে সাম্প্রতিক ভ্যালিডেশন লেয়ারে প্রয়োগ করা হয়েছে। এছাড়াও, VK_EXT_debug_report নামে একটি অবচিত এক্সটেনশন আছে, যা VK_EXT_debug_utils উপলভ্য না থাকলে একই ধরনের ক্ষমতা প্রদান করে।

Debug Utils এক্সটেনশন ব্যবহার করার আগে, আপনার ডিভাইস বা লোড করা ভ্যালিডেশন লেয়ারে এটি কাজ করে কিনা তা দেখে নিন। ডিভাইস বা ভ্যালিডেশন লেয়ারের মধ্যে কোনও একটিতে এক্সটেনশন কাজ করলে, ডিবাগ ইউটিলস এক্সটেনশন কাজ করছে কিনা তা চেক করা এবং কলব্যাক রেজিস্টার করার পদ্ধতি নিচের উদাহরণে দেখানো হয়েছে।

// Get the instance extension count.
uint32_t inst_ext_count = 0;
vkEnumerateInstanceExtensionProperties(nullptr, &inst_ext_count, nullptr);

// Enumerate the instance extensions.
VkExtensionProperties inst_exts[inst_ext_count];
vkEnumerateInstanceExtensionProperties(nullptr, &inst_ext_count, inst_exts);

// Check for debug utils extension within the system driver or loader.
// Check if the debug utils extension is available (in the driver).
VkExtensionProperties *inst_exts_end = inst_exts + inst_ext_count;
bool debugUtilsExtAvailable = inst_exts_end !=
  std::find_if(inst_exts, inst_exts_end, [](VkExtensionProperties
    extensionProperties) {
    return strcmp(extensionProperties.extensionName,
      VK_EXT_DEBUG_UTILS_EXTENSION_NAME) == 0;
  });

if ( !debugUtilsExtAvailable ) {
  // Also check the layers for the debug utils extension.
  for (auto layer: layer_props) {
    uint32_t layer_ext_count;
    vkEnumerateInstanceExtensionProperties(layer.layerName, &layer_ext_count,
      nullptr);
    if (layer_ext_count == 0) continue;
    VkExtensionProperties layer_exts[layer_ext_count];
    vkEnumerateInstanceExtensionProperties(layer.layerName, &layer_ext_count,
    layer_exts);

    VkExtensionProperties * layer_exts_end = layer_exts + layer_ext_count;
    debugUtilsExtAvailable = layer_exts != std::find_if(
      layer_exts, layer_exts_end,[](VkExtensionProperties extensionProperties) {
        return strcmp(extensionProperties.extensionName,
        VK_EXT_DEBUG_UTILS_EXTENSION_NAME) == 0;
      });
    if (debugUtilsExtAvailable) {
        // Add the including layer into the layer request list if necessary.
        break;
    }
  }
}

if (!debugUtilsExtAvailable) return; // since this snippet depends on debugUtils

const char * enabled_inst_exts[] = { ..., VK_EXT_DEBUG_UTILS_EXTENSION_NAME };
uint32_t enabled_extension_count =
  sizeof(enabled_inst_exts)/sizeof(enabled_inst_exts[0]);

// Pass the instance extensions into vkCreateInstance.
VkInstanceCreateInfo instance_info = {};
instance_info.sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO;
instance_info.enabledExtensionCount = enabled_extension_count;
instance_info.ppEnabledExtensionNames = enabled_inst_exts;

// NOTE: Can still return VK_ERROR_EXTENSION_NOT_PRESENT if validation layer
// isn't loaded.
vkCreateInstance(&instance_info, nullptr, &instance);

auto pfnCreateDebugUtilsMessengerEXT =
  (PFN_vkCreateDebugUtilsMessengerEXT)vkGetInstanceProcAddr(
    tutorialInstance, "vkCreateDebugUtilsMessengerEXT");
auto pfnDestroyDebugUtilsMessengerEXT =
  (PFN_vkDestroyDebugUtilsMessengerEXT)vkGetInstanceProcAddr(
    tutorialInstance, "vkDestroyDebugUtilsMessengerEXT");

// Create the debug messenger callback with your the settings you want.
VkDebugUtilsMessengerEXT debugUtilsMessenger;
if (pfnCreateDebugUtilsMessengerEXT) {
  VkDebugUtilsMessengerCreateInfoEXT messengerInfo;
  constexpr VkDebugUtilsMessageSeverityFlagsEXT kSeveritiesToLog =
    VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT |
    VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT;

constexpr VkDebugUtilsMessageTypeFlagsEXT kMessagesToLog =
  VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT |
  VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT |
  VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;

  messengerInfo.sType           = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
  messengerInfo.pNext           = nullptr;
  messengerInfo.flags           = 0;
  messengerInfo.messageSeverity = kSeveritiesToLog;
  messengerInfo.messageType     = kMessagesToLog;

  // The DebugUtilsMessenger callback is explained in the following section.
  messengerInfo.pfnUserCallback = &DebugUtilsMessenger;
  messengerInfo.pUserData       = nullptr; // Custom user data passed to callback

  pfnCreateDebugUtilsMessengerEXT(instance, &messengerInfo, nullptr,
    &debugUtilsMessenger);
}

// Later, when shutting down Vulkan, call the following:
if (pfnDestroyDebugUtilsMessengerEXT) {
    pfnDestroyDebugUtilsMessengerEXT(instance, debugUtilsMessenger, nullptr);
}

আপনার অ্যাপ রেজিস্টার করার এবং কলব্যাক চালু করার পরে, সিস্টেম ডিবাগিং মেসেজ এতে পাঠায়।

#include <android/log.h>

VKAPI_ATTR VkBool32 VKAPI_CALL DebugUtilsMessenger(
                        VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
                        VkDebugUtilsMessageTypeFlagsEXT messageTypes,
                        const VkDebugUtilsMessengerCallbackDataEXT *callbackData,
                        void *userData)
{
  const char validation[]  = "Validation";
  const char performance[] = "Performance";
  const char error[]       = "ERROR";
  const char warning[]     = "WARNING";
  const char unknownType[] = "UNKNOWN_TYPE";
  const char unknownSeverity[] = "UNKNOWN_SEVERITY";
  const char* typeString      = unknownType;
  const char* severityString  = unknownSeverity;
  const char* messageIdName   = callbackData->pMessageIdName;
  int32_t messageIdNumber     = callbackData->messageIdNumber;
  const char* message         = callbackData->pMessage;
  android_LogPriority priority = ANDROID_LOG_UNKNOWN;

  if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
    severityString = error;
    priority = ANDROID_LOG_ERROR;
  }
  else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
    severityString = warning;
    priority = ANDROID_LOG_WARN;
  }
  if (messageTypes & VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT) {
     typeString = validation;
  }
  else if (messageTypes & VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT) {
     typeString = performance;
  }

  __android_log_print(priority,
                     "AppName",
                     "%s %s: [%s] Code %i : %s",
                     typeString,
                     severityString,
                     messageIdName,
                     messageIdNumber,
                     message);

  // Returning false tells the layer not to stop when the event occurs, so
  // they see the same behavior with and without validation layers enabled.
  return VK_FALSE;
}

এক্সটার্নাল ভ্যালিডেশন লেয়ার ব্যবহার করুন

আপনার APK-তে ভ্যালিডেশন লেয়ার প্যাকেজ করতে হবে না; Android 9 (API লেভেল ২৮) এবং তার পরবর্তী ভার্সন চালানো ডিভাইসগুলি আপনার বাইনারির বাইরে ভ্যালিডেশন লেয়ার ব্যবহার করতে পারে এবং ডাইনামিকভাবে সেগুলি বন্ধ ও চালু করতে পারে। আপনার টেস্ট ডিভাইসে ভ্যালিডেশন লেয়ার পুশ করতে এই বিভাগে উল্লেখ করা ধাপগুলি অনুসরণ করুন:

এক্সটার্নাল ভ্যালিডেশন লেয়ার ব্যবহার করার জন্য আপনার অ্যাপ চালু করুন

Android-এর নিরাপত্তা মডেল ও নীতি অন্যান্য প্ল্যাটফর্মের থেকে উল্লেখযোগ্যভাবে আলাদা। এক্সটার্নাল ভ্যালিডেশন লেয়ার লোড করতে, নিম্নলিখিত শর্তগুলির মধ্যে একটি সত্য হতে হবে:

  • টার্গেট অ্যাপটি ডিবাগ করা যায়। এই বিকল্পের ফলে আরও ডিবাগ তথ্য পাওয়া যায়, তবে আপনার অ্যাপের পারফর্ম্যান্সের উপর নেতিবাচক প্রভাব পড়তে পারে।

  • টার্গেট অ্যাপটি অপারেটিং সিস্টেমের userdebug বিল্ডে রান করে যা রুট অ্যাক্সেস প্রদান করে।

  • শুধুমাত্র Android 11 (API লেভেল ৩০) বা তার পরবর্তী যেকোনও ভার্সনকে টার্গেট করা অ্যাপের ক্ষেত্রে: আপনার টার্গেট Android ম্যানিফেস্ট ফাইলে নিম্নলিখিত meta-data এলিমেন্ট অন্তর্ভুক্ত থাকে:

    <meta-data android:name="com.android.graphics.injectLayers.enable"
      android:value="true"/>

এক্সটার্নাল ভ্যালিডেশন লেয়ার লোড করুন

Android 9 (API লেভেল ২৮) এবং তার পরবর্তী যেকোনও ভার্সনে চলা ডিভাইসে Vulkan-কে আপনার অ্যাপের লোকাল স্টোরেজ থেকে ভ্যালিডেশন লেয়ার লোড করার অনুমতি দেওয়া হয়। Android ১০ (API লেভেল ২৯) থেকে শুরু করে, Vulkan আলাদা APK থেকে ভ্যালিডেশন লেয়ার লোড করতে পারে। আপনার Android ভার্সনে কাজ করে এমন যেকোনও পদ্ধতি আপনি বেছে নিতে পারেন।

আপনার ডিভাইসের লোকাল স্টোরেজ থেকে ভ্যালিডেশন লেয়ার বাইনারি লোড করুন

যেহেতু Vulkan আপনার ডিভাইসের অস্থায়ী ডেটা স্টোরেজ ডিরেক্টরিতে বাইনারি খোঁজে, তাই আপনাকে প্রথমে Android ডিবাগ ব্রিজ (adb) ব্যবহার করে সেই ডিরেক্টরিতে বাইনারি পুশ করতে হবে, যেমন:

  1. ডিভাইসে আপনার অ্যাপের ডেটা স্টোরেজে লেয়ার বাইনারি লোড করতে adb push কমান্ড ব্যবহার করুন:

    $ adb push libVkLayer_khronos_validation.so /data/local/tmp
    
  2. আপনার অ্যাপ প্রসেসের মাধ্যমে লেয়ার লোড করতে adb shell এবং run-as কমান্ড ব্যবহার করুন। অর্থাৎ, রুট অ্যাক্সেসের প্রয়োজন ছাড়াই অ্যাপের মতো বাইনারিরও একই ডিভাইস অ্যাক্সেস আছে।

    $ adb shell run-as com.example.myapp cp
      /data/local/tmp/libVkLayer_khronos_validation.so .
    $ adb shell run-as com.example.myapp ls libVkLayer_khronos_validation.so
    
  3. লেয়ার চালু করুন।

অন্য APK থেকে ভ্যালিডেশন লেয়ার বাইনারি লোড করুন

আপনি adb ব্যবহার করে এমন একটি APK ইনস্টল করতে পারেন যেটিতে লেয়ার আছে এবং তারপর লেয়ার চালু করতে পারেন।

adb install --abi abi path_to_apk

অ্যাপ্লিকেশনের বাইরে লেয়ার চালু করুন

আপনি Vulkan লেয়ার প্রতিটি অ্যাপের জন্য বা গ্লোবাল লেভেলে চালু করতে পারবেন। প্রতিটি অ্যাপের সেটিংস রিবুট করার পরেও থেকে যায়, তবে গ্লোবাল প্রপার্টি রিবুট করার সময় মুছে যায়।

অ্যাপ-প্রতি লেয়ার চালু করুন

প্রতিটি অ্যাপের জন্য কীভাবে লেয়ার চালু করতে হয় তা নিম্নলিখিত ধাপে বর্ণনা করা হয়েছে:

  1. লেয়ার চালু করতে adb শেল সেটিংস ব্যবহার করুন:

    $ adb shell settings put global enable_gpu_debug_layers 1
    
  2. লেয়ার চালু করার জন্য টার্গেট অ্যাপ্লিকেশন উল্লেখ করুন:

    $ adb shell settings put global gpu_debug_app <package_name>
    
  3. চালু করার জন্য লেয়ারের তালিকা নির্দিষ্ট করুন (উপর থেকে নিচে), প্রতিটি লেয়ারকে কোলন দিয়ে আলাদা করুন:

    $ adb shell settings put global gpu_debug_layers <layer1:layer2:layerN>
    

    যেহেতু আমাদের একটিই Khronos ভ্যালিডেশন লেয়ার আছে, তাই কমান্ডটি সম্ভবত এইরকম দেখতে হবে:

    $ adb shell settings put global gpu_debug_layers VK_LAYER_KHRONOS_validation
    
  4. ভিতরে লেয়ার সার্চ করার জন্য এক বা একাধিক প্যাকেজ উল্লেখ করুন:

    $ adb shell settings put global
      gpu_debug_layer_app <package1:package2:packageN>
    

নিম্নলিখিত কমান্ড ব্যবহার করে সেটিংস চালু করা আছে কিনা তা আপনি চেক করতে পারবেন:

$ adb shell settings list global | grep gpu
enable_gpu_debug_layers=1
gpu_debug_app=com.example.myapp
gpu_debug_layers=VK_LAYER_KHRONOS_validation

যেহেতু আপনার প্রয়োগ করা সেটিংস ডিভাইস রিবুট করার পরেও থেকে যায়, তাই লেয়ার লোড হওয়ার পরে আপনি সেটিংস মুছে দিতে চাইতে পারেন:

$ adb shell settings delete global enable_gpu_debug_layers
$ adb shell settings delete global gpu_debug_app
$ adb shell settings delete global gpu_debug_layers
$ adb shell settings delete global gpu_debug_layer_app

বিশ্বব্যাপী লেয়ার চালু করুন

পরবর্তী রিবুট পর্যন্ত আপনি এক বা একাধিক লেয়ার গ্লোবালি চালু করতে পারবেন। এটি নেটিভ এক্সিকিউটেবল সহ সব অ্যাপ্লিকেশনের জন্য লেয়ার লোড করার চেষ্টা করে।

$ adb shell setprop debug.vulkan.layers <layer1:layer2:layerN>