1# Copyright 2013-2024 The Khronos Group Inc. 2# 3# SPDX-License-Identifier: Apache-2.0 4 5# If a recipe fails, delete its target file. Without this cleanup, the leftover 6# file from the failed recipe can falsely satisfy dependencies on subsequent 7# runs of `make`. 8.DELETE_ON_ERROR: 9 10QUIET ?= @ 11MKDIR = mkdir -p 12CP = cp 13RM = rm -f 14RMRF = rm -rf 15 16# Generator scripts and options 17# GENOPTS can be e.g. '-noprotect' 18 19PYTHON ?= python3 20SCRIPTS = ../scripts 21XML_CONSISTENCY = $(SCRIPTS)/xml_consistency.py 22GENOPTS = 23 24# Generate Vulkan headers from XML. Many other files can be generated 25# from vk.xml using the scripts, but they are all generated from 26# ../Makefile as part of the process of building the Specification. 27# 28# Targets: 29# 30# default / install - regenerate headers in ../include/vulkan/. 31# validate - run XML validator on vk.xml against the schema. 32# test - check if vulkan_core.h compiles. 33# clean_dirt - remove intermediate files. 34# clean - remove installed and intermediate files. 35 36GENERATED = ../gen 37INCLUDE = $(GENERATED)/include 38TESTS = ../tests 39VULKAN = $(INCLUDE)/vulkan 40JSON = $(GENERATED)/out/json 41SRC = ../src 42 43VULKAN_API ?= vulkan 44ifeq ($(VULKAN_API),vulkan) 45API_SUFFIX := 46MISRACOPTS ?= 47MISRACPPOPTS ?= 48else 49API_SUFFIX := _sc 50# default options for generating MISRA C or MISRA C++ headers 51# can be overridden from commandline 52MISRACOPTS ?= -misracstyle 53MISRACPPOPTS ?= -misracppstyle 54endif 55 56# Static files needed for a complete set of headers, cached in the 57# repository 58STATIC_HEADERS = $(VULKAN)/vulkan$(API_SUFFIX).h $(VULKAN)/vk_platform.h 59 60# Where static headers are stored 61STATIC = ../include/vulkan 62STATIC_JSON_SRC = ../json 63 64# Vulkan platform-specific headers 65PLATFORM_HEADERS = \ 66 $(VULKAN)/vulkan_android.h \ 67 $(VULKAN)/vulkan_fuchsia.h \ 68 $(VULKAN)/vulkan_ggp.h \ 69 $(VULKAN)/vulkan_ios.h \ 70 $(VULKAN)/vulkan_macos.h \ 71 $(VULKAN)/vulkan_vi.h \ 72 $(VULKAN)/vulkan_wayland.h \ 73 $(VULKAN)/vulkan_win32.h \ 74 $(VULKAN)/vulkan_xcb.h \ 75 $(VULKAN)/vulkan_xlib.h \ 76 $(VULKAN)/vulkan_directfb.h \ 77 $(VULKAN)/vulkan_xlib_xrandr.h \ 78 $(VULKAN)/vulkan_metal.h \ 79 $(VULKAN)/vulkan_screen.h \ 80 $(VULKAN)/vulkan_beta.h 81 82#@ vulkan_sci.h is Vulkan SC-specific 83ifeq ($(VULKAN_API),vulkansc) 84PLATFORM_HEADERS := $(PLATFORM_HEADERS) $(VULKAN)/vulkan_sci.h 85endif 86 87HEADERS_H = $(VULKAN)/vulkan$(API_SUFFIX)_core.h $(PLATFORM_HEADERS) 88ifeq ($(VULKAN_API),vulkansc) 89HEADERS_HPP = $(VULKAN)/vulkan$(API_SUFFIX)_core.hpp 90STATIC_JSON = $(STATIC_JSON_SRC)/vkpcc.json 91JSON_PCC = $(JSON)/vkpcc.json 92STATIC_CTS_COPY = \ 93 $(JSON)/cts/vkjson_data_default.h \ 94 $(JSON)/cts/vkjson_parser_default.h 95JSON_SCHEMA = $(JSON)/vk.json 96JSON_GENERATOR = $(JSON)/vulkan_json_data.hpp \ 97 $(JSON)/vulkan_json_gen.h \ 98 $(JSON)/vulkan_json_gen.c 99JSON_PARSER = $(JSON)/vulkan_json_parser.hpp 100JSON_CTS = $(JSON)/cts/vulkan_json_data.hpp $(JSON)/cts/vulkan_json_parser.hpp 101JSON_SCRIPTS = $(SCRIPTS)/json_parser.py $(SCRIPTS)/json_generator.py 102endif 103HEADERS = $(HEADERS_H) $(HEADERS_HPP) 104JSON_FILES = $(JSON_SCHEMA) $(JSON_GENERATOR) $(JSON_PARSER) 105JSON_CTS_FILES = $(JSON_CTS) 106 107default: install 108 109install: $(HEADERS) $(STATIC_HEADERS) $(CODEC_HEADERS) $(JSON_FILES) $(JSON_PCC) $(JSON_CTS_FILES) $(STATIC_CTS_COPY) 110 111$(VULKAN)/vulkan$(API_SUFFIX).h: $(STATIC)/vulkan$(API_SUFFIX).h 112 $(QUIET)$(MKDIR) $(VULKAN) 113 $(CP) $? $@ 114 115$(VULKAN)/vulkan$(API_SUFFIX).hpp: $(STATIC)/vulkan$(API_SUFFIX).h 116 $(QUIET)$(MKDIR) $(VULKAN) 117 $(CP) $? $@ 118 119$(VULKAN)/vk_platform.h: $(STATIC)/vk_platform.h 120 $(QUIET)$(MKDIR) $(VULKAN) 121 $(CP) $? $@ 122 123################################################ 124 125# Autogenerate vulkan header from XML API description 126 127# Python and XML files on which vulkan_core.h depends 128GENSCRIPT = $(SCRIPTS)/genvk.py 129VKXML = vk.xml 130VKH_DEPENDS = $(VKXML) $(GENSCRIPT) $(SCRIPTS)/reg.py $(SCRIPTS)/generator.py 131 132$(HEADERS_H): $(VKH_DEPENDS) 133 $(MKDIR) $(VULKAN) 134 $(PYTHON) $(GENSCRIPT) $(MISRACOPTS) $(GENOPTS) -registry $(VKXML) \ 135 -o $(VULKAN) $(notdir $@) 136 137$(HEADERS_HPP): $(VKH_DEPENDS) 138 $(MKDIR) $(VULKAN) 139 $(PYTHON) $(GENSCRIPT) $(MISRACPPOPTS) $(GENOPTS) -registry $(VKXML) \ 140 -o $(VULKAN) $(notdir $@) 141 142platform: $(PLATFORM_HEADERS) 143 144# Autogenerate video codec headers from XML 145 146VIDEO_INCLUDE = $(INCLUDE)/vk_video 147CODECS = vulkan_video_codecs_common.h \ 148 vulkan_video_codec_h264std.h \ 149 vulkan_video_codec_h264std_decode.h \ 150 vulkan_video_codec_h264std_encode.h \ 151 vulkan_video_codec_h265std.h \ 152 vulkan_video_codec_h265std_decode.h \ 153 vulkan_video_codec_h265std_encode.h 154CODECXML = video.xml 155# Do not build video headers for Vulkan SC 156ifeq ($(VULKAN_API),vulkan) 157CODEC_HEADERS = $(CODECS:%=$(VIDEO_INCLUDE)/%) 158else 159CODEC_HEADERS = 160endif 161 162codec_headers: $(CODEC_HEADERS) 163 164$(VIDEO_INCLUDE)/%.h: $(CODECXML) $(GENSCRIPT) $(SCRIPTS)/reg.py $(SCRIPTS)/generator.py 165 $(QUIET)$(MKDIR) $(VIDEO_INCLUDE) 166 $(QUIET)$(PYTHON) $(GENSCRIPT) $(GENOPTS) -registry $(CODECXML) -o $(VIDEO_INCLUDE) $(notdir $@) 167 168# Verify registry XML files against the schema 169validate: 170 jing -c registry.rnc $(VKXML) 171 $(PYTHON) $(XML_CONSISTENCY) $(VKXML) 172 jing -c registry.rnc $(CODECXML) 173 174# Test that generated Vulkan headers compile 175 176# Platforms to test 177TESTDEFS = -DVK_USE_PLATFORM_XCB_KHR -DVK_USE_PLATFORM_XLIB_KHR 178 179TESTFILE = $(TESTS)/htest$(API_SUFFIX).c 180 181#@ -DUSE_HPP=1 is used only for Vulkan SC build 182test: $(HEADERS) $(STATIC_HEADERS) $(CODEC_HEADERS) 183 gcc -Wall -pedantic-errors -std=c99 -c -I$(INCLUDE) -I$(TESTS) $(TESTFILE) 184 gcc -Wall -pedantic-errors -std=c11 -c -I$(INCLUDE) -I$(TESTS) $(TESTFILE) 185 g++ -Wall -pedantic-errors -c -std=c++11 -I$(INCLUDE) -I$(TESTS) $(TESTFILE) 186ifeq ($(VULKAN_API),vulkansc) 187 g++ -Wall -pedantic-errors -c -std=c++98 -I$(INCLUDE) -I$(TESTS) $(TESTFILE) 188 g++ -Wall -pedantic-errors -c -std=c++11 -I$(INCLUDE) -I$(TESTS) -DUSE_HPP=1 $(TESTFILE) 189endif 190 $(RM) htest.o $(TESTS)/test.o 191 192# Test that generated video codec headers compile 193 194vtest: $(CODEC_HEADERS) 195 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODECS_COMMON 196 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H264STD 197 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H264STD_DECODE 198 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H264STD_ENCODE 199 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H264STD -D VULKAN_VIDEO_CODEC_H264STD_DECODE -D VULKAN_VIDEO_CODEC_H264STD_ENCODE 200 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H265STD 201 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H265STD_DECODE 202 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H265STD_ENCODE 203 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_CODEC_H265STD -D VULKAN_VIDEO_CODEC_H265STD_DECODE -D VULKAN_VIDEO_CODEC_H265STD_ENCODE 204 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_ALL 205 gcc -Wall -std=c99 -c -I$(INCLUDE) $(TESTS)/vtest.c -D VULKAN_VIDEO_ALL -D VK_NO_STDINT_H 206 $(RM) vtest.o 207 208################################################ 209 210# Autogenerate JSON Schema and utils from the XML API description 211$(JSON_FILES): $(VKH_DEPENDS) $(JSON_SCRIPTS) 212 $(QUIET)$(MKDIR) $(JSON) 213 $(PYTHON) $(GENSCRIPT) $(GENOPTS) -registry $(VKXML) \ 214 -o $(JSON) $(notdir $@) 215 216$(JSON_CTS_FILES): $(VKH_DEPENDS) $(JSON_SCRIPTS) 217 $(QUIET)$(MKDIR) $(JSON)/cts 218 $(PYTHON) $(GENSCRIPT) $(GENOPTS) -registry $(VKXML) --iscts \ 219 -o $(JSON)/cts $(notdir $@) 220 221$(JSON)/cts/vkjson_data_default.h: $(STATIC_JSON_SRC)/vkjson_data_default.h 222 $(QUIET)$(MKDIR) $(JSON)/cts 223 $(CP) $? $@ 224 225$(JSON)/cts/vkjson_parser_default.h: $(STATIC_JSON_SRC)/vkjson_parser_default.h 226 $(QUIET)$(MKDIR) $(JSON)/cts 227 $(CP) $? $@ 228 229$(JSON_PCC): $(STATIC_JSON) 230 $(QUIET)$(MKDIR) $(JSON) 231 $(CP) $? $@ 232 233################################################ 234 235# Files to clean up 236PYDIRT = diag.txt dumpReg.txt errwarn.txt *.pyc regdump.txt 237DIRT = $(PYDIRT) ERRS *.o 238 239# Clean intermediate files 240clean_dirt: 241 -$(RM) $(DIRT) \#* 242 243# Clean generated targets and intermediates 244clean clobber: clean_dirt 245 -$(RMRF) $(INCLUDE) $(JSON) 246 -$(RMRF) $(INCLUDE) $(VIDEO_INCLUDE) 247