vk_print.c File Reference

Printing helper code. More...

#include "util/u_pretty_print.h"
#include "vk/vk_helpers.h"
#include "vk/vk_print.h"

Include dependency graph for vk_print.c:

Macros
#define	P(...)   u_pp(dg, __VA_ARGS__)
#define	PNT(...)   u_pp(dg, "\n\t" __VA_ARGS__)
#define	PNTT(...)   u_pp(dg, "\n\t\t" __VA_ARGS__)
#define	PRINT_BITS(BITS, FUNC)
#define	ENUM_TO_STR(r)    case r: return #r

Functions
static void	print_queue_non_null (u_pp_delegate_t dg, const char *prefix, const struct vk_bundle_queue *queue)
static void	print_queue (u_pp_delegate_t dg, const char *prefix, const struct vk_bundle_queue *queue)
void	vk_print_result (struct vk_bundle *vk, const char *file, int line, const char *calling_func, VkResult ret, const char *called_func)
	Print the result of a function, info level if ret == VK_SUCCESS and error level otherwise.
void	vk_print_device_info (struct vk_bundle *vk, enum u_logging_level log_level, const VkPhysicalDeviceProperties *pdp, uint32_t gpu_index, const char *title)
	Print device information to the logger at the given logging level, if the vk_bundle has that level enabled.
void	vk_print_opened_device_info (struct vk_bundle *vk, enum u_logging_level log_level)
	Print device information about the device that bundle manages at the given logging level if the vk_bundle has that level enabled.
void	vk_print_features_info (struct vk_bundle *vk, enum u_logging_level log_level)
	Print device features to the logger at the given logging level, if the vk_bundle has that level enabled.
void	vk_print_external_handles_info (struct vk_bundle *vk, enum u_logging_level log_level)
	Print external handle features to the logger at the given logging level, if the vk_bundle has that level enabled.
void	vk_print_swapchain_create_info (struct vk_bundle *vk, VkSwapchainCreateInfoKHR *i, enum u_logging_level log_level)
	Print a VkSwapchainCreateInfoKHR, used to log during creation.
void	vk_print_queues_info (const struct vk_bundle *vk, enum u_logging_level log_level)
	Print queue info to the logger at the given logging level, if the vk_bundle has that level enabled.
XRT_CHECK_RESULT const char *	vk_result_string (VkResult code)
XRT_CHECK_RESULT const char *	vk_object_type_string (VkObjectType type)
XRT_CHECK_RESULT const char *	vk_physical_device_type_string (VkPhysicalDeviceType device_type)
XRT_CHECK_RESULT const char *	vk_format_string (VkFormat code)
XRT_CHECK_RESULT const char *	vk_sharing_mode_string (VkSharingMode code)
XRT_CHECK_RESULT const char *	vk_present_mode_string (VkPresentModeKHR code)
XRT_CHECK_RESULT const char *	vk_color_space_string (VkColorSpaceKHR code)
XRT_CHECK_RESULT const char *	vk_power_state_string (VkDisplayPowerStateEXT code)
XRT_CHECK_RESULT const char *	vk_format_feature_flag_string (VkFormatFeatureFlagBits bits, bool null_on_unknown)
	Returns the format feature flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.
XRT_CHECK_RESULT const char *	vk_image_usage_flag_string (VkImageUsageFlagBits bits, bool null_on_unknown)
	Returns the image usage flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.
XRT_CHECK_RESULT const char *	vk_composite_alpha_flag_string (VkCompositeAlphaFlagBitsKHR bits, bool null_on_unknown)
	Returns the composite alpha flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.
XRT_CHECK_RESULT const char *	vk_surface_transform_flag_string (VkSurfaceTransformFlagBitsKHR bits, bool null_on_unknown)
	Returns the surface transform flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.
XRT_CHECK_RESULT const char *	xrt_swapchain_usage_flag_string (enum xrt_swapchain_usage_bits bits, bool null_on_unknown)
	Returns xrt swapchain_usage flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.

Detailed Description

Printing helper code.

Author

Jakob Bornecrantz jakob.nosp@m.@col.nosp@m.labor.nosp@m.a.co.nosp@m.m

Christoph Haag chris.nosp@m.toph.nosp@m..haag.nosp@m.@col.nosp@m.labor.nosp@m.a.co.nosp@m.m

Beyley Cardellio ep1cm.nosp@m.1n10.nosp@m.n123@.nosp@m.gmai.nosp@m.l.com

Macro Definition Documentation

PRINT_BITS

#define PRINT_BITS	(		BITS,
			FUNC
	)

Value:

        do {                                                                                                           \
                for (uint32_t index = 0; index < 32; index++) {                                                        \
                        uint32_t bit = (BITS) & (1u << index);                                                         \
                        if (!bit) {                                                                                    \
                                continue;                                                                              \
                        }                                                                                              \
                        const char *str = FUNC(bit, true);                                                             \
                        if (str != NULL) {                                                                             \
                                PNTT("%s", str);                                                                       \
                        } else {                                                                                       \
                                PNTT("0x%08x", bit);                                                                   \
                        }                                                                                              \
                }                                                                                                      \
        } while (false)

Function Documentation

vk_composite_alpha_flag_string()

XRT_CHECK_RESULT const char * vk_composite_alpha_flag_string	(	VkCompositeAlphaFlagBitsKHR	bits,
		bool	null_on_unknown
	)

Returns the composite alpha flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.

Referenced by vk_print_surface_info(), and vk_print_swapchain_create_info().

vk_format_feature_flag_string()

XRT_CHECK_RESULT const char * vk_format_feature_flag_string	(	VkFormatFeatureFlagBits	bits,
		bool	null_on_unknown
	)

Returns the format feature flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.

vk_image_usage_flag_string()

XRT_CHECK_RESULT const char * vk_image_usage_flag_string	(	VkImageUsageFlagBits	bits,
		bool	null_on_unknown
	)

Returns the image usage flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.

Referenced by vk_print_surface_info(), and vk_print_swapchain_create_info().

vk_print_external_handles_info()

void vk_print_external_handles_info	(	struct vk_bundle *	vk,
		enum u_logging_level	log_level
	)

Print external handle features to the logger at the given logging level, if the vk_bundle has that level enabled.

References U_LOG_IFL.

vk_print_features_info()

void vk_print_features_info	(	struct vk_bundle *	vk,
		enum u_logging_level	log_level
	)

Print device features to the logger at the given logging level, if the vk_bundle has that level enabled.

References vk_bundle::timeline_semaphore, vk_bundle::timestamp_compute_and_graphics, vk_bundle::timestamp_period, vk_bundle::timestamp_valid_bits, and U_LOG_IFL.

vk_print_queues_info()

void vk_print_queues_info	(	const struct vk_bundle *	vk,
		enum u_logging_level	log_level
	)

Print queue info to the logger at the given logging level, if the vk_bundle has that level enabled.

References u_pp_sink_stack_only::buffer, vk_bundle::graphics_queue, vk_bundle::main_queue, and U_LOG_IFL.

vk_print_swapchain_create_info()

void vk_print_swapchain_create_info	(	struct vk_bundle *	vk,
		VkSwapchainCreateInfoKHR *	i,
		enum u_logging_level	log_level
	)

Print a VkSwapchainCreateInfoKHR, used to log during creation.

References u_pp_sink_stack_only::buffer, U_LOG_IFL, vk_composite_alpha_flag_string(), vk_image_usage_flag_string(), and vk_surface_transform_flag_string().

vk_surface_transform_flag_string()

XRT_CHECK_RESULT const char * vk_surface_transform_flag_string	(	VkSurfaceTransformFlagBitsKHR	bits,
		bool	null_on_unknown
	)

Returns the surface transform flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.

Referenced by vk_print_surface_info(), and vk_print_swapchain_create_info().

xrt_swapchain_usage_flag_string()

XRT_CHECK_RESULT const char * xrt_swapchain_usage_flag_string	(	enum xrt_swapchain_usage_bits	bits,
		bool	null_on_unknown
	)

Returns xrt swapchain_usage flag if one valid bit is set, if multiple bits are set, will return 'MULTIPLE BIT SET'.