From de7bbab69946aaac267197a87255f53d28e0b5da Mon Sep 17 00:00:00 2001 From: bsalomon Date: Thu, 3 Mar 2016 15:43:03 -0800 Subject: Pull and build shaderc rather than use checked in lib/header GOLD_TRYBOT_URL= https://gold.skia.org/search2?unt=true&query=source_type%3Dgm&master=false&issue=1760493003 Committed: https://skia.googlesource.com/skia/+/7d4490ecfa4d974003f675ef004e77f85ecfadd2 Review URL: https://codereview.chromium.org/1760493003 --- DEPS | 6 + gyp/gpu.gyp | 14 +- gyp/shaderc.gyp | 63 +++++ third_party/shaderc/Debug/shaderc_combined.lib | Bin 84464322 -> 0 bytes third_party/shaderc/Release/shaderc_combined.lib | Bin 29673558 -> 0 bytes third_party/shaderc/shaderc.h | 321 ----------------------- tools/build_shaderc.py | 81 ++++++ 7 files changed, 157 insertions(+), 328 deletions(-) create mode 100644 gyp/shaderc.gyp delete mode 100644 third_party/shaderc/Debug/shaderc_combined.lib delete mode 100644 third_party/shaderc/Release/shaderc_combined.lib delete mode 100644 third_party/shaderc/shaderc.h create mode 100644 tools/build_shaderc.py diff --git a/DEPS b/DEPS index a723d8d7ce..b080b2235c 100644 --- a/DEPS +++ b/DEPS @@ -50,6 +50,12 @@ deps = { # Mojo SDK for Mojo RPC experiments. "third_party/externals/mojo/public" : "https://chromium.googlesource.com/external/github.com/domokit/mojo_sdk@172be18ea745ab29aea132e6cb952e726dc32543", + + # shaderc for the vulkan backend + "third_party/externals/shaderc2" : "https://github.com/google/shaderc.git@f76848a36d539888828006b9b7c088b3f362b607", + "third_party/externals/shaderc2/third_party/googletest" : "https://github.com/google/googletest.git@ff07a5de0e81580547f1685e101194ed1a4fcd56", + "third_party/externals/shaderc2/third_party/glslang" : "https://github.com/bsalomon/glslang.git@5dc8a76265ee31733b5a765e034ad7f5097a3cbe", + "third_party/externals/shaderc2/third_party/spirv-tools" : "https://github.com/KhronosGroup/SPIRV-Tools.git@c31a31942b3697f2f71148555e5ffa298a572dbd", # xSAN bots build Clang from scratch. "third_party/externals/llvm": "https://llvm.googlesource.com/llvm@release_38", diff --git a/gyp/gpu.gyp b/gyp/gpu.gyp index 43204a4548..057b742510 100644 --- a/gyp/gpu.gyp +++ b/gyp/gpu.gyp @@ -235,12 +235,17 @@ }, }], [ 'skia_vulkan', { + 'dependencies': [ + 'shaderc.gyp:shaderc_combined', + ], 'include_dirs': [ - '../third_party/' # To include files under third_party/vulkan + '../third_party/', # To include files under third_party/vulkan + '../third_party/externals/shaderc2/libshaderc/include', ], 'direct_dependent_settings': { 'include_dirs': [ - '../third_party/' # To include files under third_party/vulkan + '../third_party/', # To include files under third_party/vulkan + '../third_party/externals/shaderc2/libshaderc/include', ], }, 'conditions' : [ @@ -250,7 +255,6 @@ 'VCLinkerTool': { 'AdditionalDependencies': [ 'vulkan-1.lib', - 'shaderc_combined.lib' ], }, }, @@ -262,7 +266,6 @@ 'VCLinkerTool': { 'AdditionalLibraryDirectories': [ '../third_party/vulkan', - '../third_party/shaderc/Debug', ], }, }, @@ -272,7 +275,6 @@ 'VCLinkerTool': { 'AdditionalLibraryDirectories': [ '../third_party/vulkan', - '../third_party/shaderc/Release', ], }, }, @@ -282,7 +284,6 @@ 'VCLinkerTool': { 'AdditionalLibraryDirectories': [ '../third_party/vulkan', - '../third_party/shaderc/Debug', ], }, }, @@ -292,7 +293,6 @@ 'VCLinkerTool': { 'AdditionalLibraryDirectories': [ '../third_party/vulkan', - '../third_party/shaderc/Release', ], }, }, diff --git a/gyp/shaderc.gyp b/gyp/shaderc.gyp new file mode 100644 index 0000000000..2b1b8f1deb --- /dev/null +++ b/gyp/shaderc.gyp @@ -0,0 +1,63 @@ +# Copyright 2016 Google Inc. +# +# Use of this source code is governed by a BSD-style license that can be +# found in the LICENSE file. + +# Builds shaderc for the Vulkan backend +{ + 'variables': { + 'conditions': [ + [ 'CONFIGURATION_NAME == "Release_Developer"', { + 'shaderc_build_type' : 'Release', + }, { + 'shaderc_build_type' : '<(CONFIGURATION_NAME)', + }], + [ 'skia_os == "win"', { + 'shaderc_lib_name' : 'shaderc_combined.lib', + }, { + 'shaderc_lib_name' : 'libshaderc_combined.a', + }], + [ 'MSVS_VERSION == "2013"', { + 'shaderc_project_type' : 'MSVS2013', + }], + [ 'MSVS_VERSION == "2015"', { + 'shaderc_project_type' : 'MSVS2015', + }], + ], + 'skia_build_type' : '<(CONFIGURATION_NAME)', + }, + 'targets': [ + { + # Call out to a python script to build shaderc_combined and then copy it + # to out/ + 'target_name': 'shaderc_combined', + 'type': 'none', + 'actions': [ + { + 'action_name': 'compile_shaderc', + 'inputs': [ + ' -#include -#include - -typedef enum { - // Forced shader kinds. These shader kinds force the compiler to compile the - // source code as the specified kind of shader. - shaderc_glsl_vertex_shader, - shaderc_glsl_fragment_shader, - shaderc_glsl_compute_shader, - shaderc_glsl_geometry_shader, - shaderc_glsl_tess_control_shader, - shaderc_glsl_tess_evaluation_shader, - // Deduce the shader kind from #pragma annotation in the source code. Compiler - // will emit error if #pragma annotation is not found. - shaderc_glsl_infer_from_source, - // Default shader kinds. Compiler will fall back to compile the source code as - // the specified kind of shader when #pragma annotation is not found in the - // source code. - shaderc_glsl_default_vertex_shader, - shaderc_glsl_default_fragment_shader, - shaderc_glsl_default_compute_shader, - shaderc_glsl_default_geometry_shader, - shaderc_glsl_default_tess_control_shader, - shaderc_glsl_default_tess_evaluation_shader, -} shaderc_shader_kind; - -typedef enum { - shaderc_target_env_vulkan, // create SPIR-V under Vulkan semantics - shaderc_target_env_opengl, // create SPIR-V under OpenGL semantics - shaderc_target_env_opengl_compat, // create SPIR-V under OpenGL semantics, - // including compatibility profile - // functions - shaderc_target_env_default = shaderc_target_env_vulkan -} shaderc_target_env; - -typedef enum { - shaderc_profile_none, // Used if and only if GLSL version did not specify - // profiles. - shaderc_profile_core, - shaderc_profile_compatibility, - shaderc_profile_es, -} shaderc_profile; - -// Indicate the status of a compilation. -typedef enum { - shaderc_compilation_status_success = 0, - shaderc_compilation_status_invalid_stage, // error stage deduction - shaderc_compilation_status_compilation_error, - shaderc_compilation_status_internal_error, // unexpected failure - shaderc_compilation_status_null_result_object, -} shaderc_compilation_status; - -// Usage examples: -// -// Aggressively release compiler resources, but spend time in initialization -// for each new use. -// shaderc_compiler_t compiler = shaderc_compiler_initialize(); -// shaderc_compilation_result_t result = shaderc_compile_into_spv( -// compiler, "int main() {}", 13, shaderc_glsl_vertex_shader, "main"); -// // Do stuff with compilation results. -// shaderc_result_release(result); -// shaderc_compiler_release(compiler); -// -// Keep the compiler object around for a long time, but pay for extra space -// occupied. -// shaderc_compiler_t compiler = shaderc_compiler_initialize(); -// // On the same, other or multiple simultaneous threads. -// shaderc_compilation_result_t result = shaderc_compile_into_spv( -// compiler, "int main() {}", 13, shaderc_glsl_vertex_shader, "main"); -// // Do stuff with compilation results. -// shaderc_result_release(result); -// // Once no more compilations are to happen. -// shaderc_compiler_release(compiler); - -// An opaque handle to an object that manages all compiler state. -typedef struct shaderc_compiler* shaderc_compiler_t; - -// Returns a shaderc_compiler_t that can be used to compile modules. -// A return of NULL indicates that there was an error initializing the compiler. -// Any function operating on shaderc_compiler_t must offer the basic -// thread-safety guarantee. -// [http://herbsutter.com/2014/01/13/gotw-95-solution-thread-safety-and-synchronization/] -// That is: concurrent invocation of these functions on DIFFERENT objects needs -// no synchronization; concurrent invocation of these functions on the SAME -// object requires synchronization IF AND ONLY IF some of them take a non-const -// argument. -shaderc_compiler_t shaderc_compiler_initialize(void); - -// Releases the resources held by the shaderc_compiler_t. -// After this call it is invalid to make any future calls to functions -// involving this shaderc_compiler_t. -void shaderc_compiler_release(shaderc_compiler_t); - -// An opaque handle to an object that manages options to a single compilation -// result. -typedef struct shaderc_compile_options* shaderc_compile_options_t; - -// Returns a default-initialized shaderc_compile_options_t that can be used -// to modify the functionality of a compiled module. -// A return of NULL indicates that there was an error initializing the options. -// Any function operating on shaderc_compile_options_t must offer the -// basic thread-safety guarantee. -shaderc_compile_options_t shaderc_compile_options_initialize(void); - -// Returns a copy of the given shaderc_compile_options_t. -// If NULL is passed as the parameter the call is the same as -// shaderc_compile_options_init. -shaderc_compile_options_t shaderc_compile_options_clone( - const shaderc_compile_options_t options); - -// Releases the compilation options. It is invalid to use the given -// shaderc_compile_options_t object in any future calls. It is safe to pass -// NULL to this function, and doing such will have no effect. -void shaderc_compile_options_release(shaderc_compile_options_t options); - -// Adds a predefined macro to the compilation options. This has the same -// effect as passing -Dname=value to the command-line compiler. If value -// is NULL, it has the same effect as passing -Dname to the command-line -// compiler. If a macro definition with the same name has previously been -// added, the value is replaced with the new value. The macro name and -// value are passed in with char pointers, which point to their data, and -// the lengths of their data. The strings that the name and value pointers -// point to must remain valid for the duration of the call, but can be -// modified or deleted after this function has returned. In case of adding -// a valueless macro, the value argument should be a null pointer or the -// value_length should be 0u. -void shaderc_compile_options_add_macro_definition( - shaderc_compile_options_t options, const char* name, size_t name_length, - const char* value, size_t value_length); - -// Sets the compiler mode to generate debug information in the output. -void shaderc_compile_options_set_generate_debug_info( - shaderc_compile_options_t options); - -// Forces the GLSL language version and profile to a given pair. The version -// number is the same as would appear in the #version annotation in the source. -// Version and profile specified here overrides the #version annotation in the -// source. Use profile: 'shaderc_profile_none' for GLSL versions that do not -// define profiles, e.g. versions below 150. -void shaderc_compile_options_set_forced_version_profile( - shaderc_compile_options_t options, int version, shaderc_profile profile); - -// Response to a request for #include content. "Includer" is client code that -// resolves #include arguments into objects of this type. -// -// TODO: File inclusion needs to be context-aware. -// e.g. -// In file: /path/to/main_shader.vert: -// #include "include/a" -// In file: /path/to/include/a": -// #include "b" -// When compiling /path/to/main_shader.vert, the compiler should be able to -// go to /path/to/include/b to find the file b. -// This needs context info from compiler to client includer, and may needs -// interface changes. -struct shaderc_includer_response { - const char* path; - size_t path_length; - const char* content; - size_t content_length; -}; - -// A function mapping a #include argument to its includer response. The -// includer retains memory ownership of the response object. -typedef shaderc_includer_response* (*shaderc_includer_response_get_fn)( - void* user_data, const char* filename); - -// A function to destroy an includer response when it's no longer needed. -typedef void (*shaderc_includer_response_release_fn)( - void* user_data, shaderc_includer_response* data); - -// Sets includer callback functions. When a compiler encounters a #include in -// the source, it will query the includer by invoking getter on user_data and -// the #include argument. The includer must respond with a -// shaderc_includer_response object that remains valid until releaser is invoked -// on it. When the compiler is done processing the response, it will invoke -// releaser on user_data and the response pointer. -void shaderc_compile_options_set_includer_callbacks( - shaderc_compile_options_t options, shaderc_includer_response_get_fn getter, - shaderc_includer_response_release_fn releaser, void* user_data); - -// Sets the compiler mode to suppress warnings, overriding warnings-as-errors -// mode. When both suppress-warnings and warnings-as-errors modes are -// turned on, warning messages will be inhibited, and will not be emitted -// as error messages. -void shaderc_compile_options_set_suppress_warnings( - shaderc_compile_options_t options); - -// Sets the target shader environment, affecting which warnings or errors will -// be issued. The version will be for distinguishing between different versions -// of the target environment. "0" is the only supported version at this point -void shaderc_compile_options_set_target_env(shaderc_compile_options_t options, - shaderc_target_env target, - uint32_t version); - -// Sets the compiler mode to treat all warnings as errors. Note the -// suppress-warnings mode overrides this option, i.e. if both -// warning-as-errors and suppress-warnings modes are set, warnings will not -// be emitted as error messages. -void shaderc_compile_options_set_warnings_as_errors( - shaderc_compile_options_t options); - -// An opaque handle to the results of a call to any shaderc_compile_into_*() -// function. -typedef struct shaderc_compilation_result* shaderc_compilation_result_t; - -// Takes a GLSL source string and the associated shader kind, input file -// name, compiles it according to the given additional_options. If the shader -// kind is not set to a specified kind, but shaderc_glslc_infer_from_source, -// the compiler will try to deduce the shader kind from the source -// string and a failure in deducing will generate an error. Currently only -// #pragma annotation is supported. If the shader kind is set to one of the -// default shader kinds, the compiler will fall back to the default shader -// kind in case it failed to deduce the shader kind from source string. -// The input_file_name is a null-termintated string. It is used as a tag to -// identify the source string in cases like emitting error messages. It -// doesn't have to be a 'file name'. -// The source string will be compiled into SPIR-V binary and a -// shaderc_compilation_result will be returned to hold the results. -// The entry_point_name null-terminated string defines the name of the entry -// point to associate with this GLSL source. If the additional_options -// parameter is not null, then the compilation is modified by any options -// present. May be safely called from multiple threads without explicit -// synchronization. If there was failure in allocating the compiler object, -// null will be returned. -shaderc_compilation_result_t shaderc_compile_into_spv( - const shaderc_compiler_t compiler, const char* source_text, - size_t source_text_size, shaderc_shader_kind shader_kind, - const char* input_file_name, const char* entry_point_name, - const shaderc_compile_options_t additional_options); - -// Like shaderc_compile_into_spv, but the result contains SPIR-V assembly text -// instead of a SPIR-V binary module. The SPIR-V assembly syntax is as defined -// by the SPIRV-Tools open source project. -shaderc_compilation_result_t shaderc_compile_into_spv_assembly( - const shaderc_compiler_t compiler, const char* source_text, - size_t source_text_size, shaderc_shader_kind shader_kind, - const char* input_file_name, const char* entry_point_name, - const shaderc_compile_options_t additional_options); - -// Like shaderc_compile_into_spv, but the result contains preprocessed source -// code instead of a SPIR-V binary module -shaderc_compilation_result_t shaderc_compile_into_preprocessed_text( - const shaderc_compiler_t compiler, const char* source_text, - size_t source_text_size, shaderc_shader_kind shader_kind, - const char* input_file_name, const char* entry_point_name, - const shaderc_compile_options_t additional_options); - -// The following functions, operating on shaderc_compilation_result_t objects, -// offer only the basic thread-safety guarantee. - -// Releases the resources held by the result object. It is invalid to use the -// result object for any further operations. -void shaderc_result_release(shaderc_compilation_result_t result); - -// Returns the number of bytes of the compilation output data in a result -// object. -size_t shaderc_result_get_length(const shaderc_compilation_result_t result); - -// Returns the number of warnings generated during the compilation. -size_t shaderc_result_get_num_warnings( - const shaderc_compilation_result_t result); - -// Returns the number of errors generated during the compilation. -size_t shaderc_result_get_num_errors(const shaderc_compilation_result_t result); - -// Returns the compilation status, indicating whether the compilation succeeded, -// or failed due to some reasons, like invalid shader stage or compilation -// errors. -shaderc_compilation_status shaderc_result_get_compilation_status( - const shaderc_compilation_result_t); - -// Returns a pointer to the start of the compilation output data bytes, either -// SPIR-V binary or char string. When the source string is compiled into SPIR-V -// binary, this is guaranteed to be castable to a uint32_t*. If the result -// contains assembly text or preprocessed source text, the pointer will point to -// the resulting array of characters. -const char* shaderc_result_get_bytes(const shaderc_compilation_result_t result); - -// Returns a null-terminated string that contains any error messages generated -// during the compilation. -const char* shaderc_result_get_error_message( - const shaderc_compilation_result_t result); - -// Provides the version & revision of the SPIR-V which will be produced -void shaderc_get_spv_version(unsigned int* version, unsigned int* revision); - -// Parses the version and profile from a given null-terminated string -// containing both version and profile, like: '450core'. Returns false if -// the string can not be parsed. Returns true when the parsing succeeds. The -// parsed version and profile are returned through arguments. -bool shaderc_parse_version_profile(const char* str, int* version, - shaderc_profile* profile); - -#ifdef __cplusplus -} -#endif // __cplusplus - -#endif // SHADERC_SHADERC_H_ diff --git a/tools/build_shaderc.py b/tools/build_shaderc.py new file mode 100644 index 0000000000..1f05e84672 --- /dev/null +++ b/tools/build_shaderc.py @@ -0,0 +1,81 @@ +#!/usr/bin/python + +# Copyright 2016 Google Inc. +# +# Use of this source code is governed by a BSD-style license that can be +# found in the LICENSE file. + + +""" +Script to build the shaderc library. +""" + +import argparse +import os +import shlex +import shutil +import subprocess +import sys + +def main(): + parser = argparse.ArgumentParser(description='Builds shaderc') + parser.add_argument('-s', '--src-dir', required=True, help= + 'path to shaderc source') + parser.add_argument('-t', '--build-type', required=True, help= + 'Either Release or Debug') + parser.add_argument('-a', '--arch-type', required=True, help= + 'Either x86 or x86_64') + parser.add_argument('-o', '--output-dir', required=True, help= + 'Directory for cmake build') + parser.add_argument('-p', '--project_type', required=True, help= + 'Project type to use. Must be "ninja", "MSVS2013", or "MSVS2015"') + args = parser.parse_args() + + args.src_dir = os.path.abspath(args.src_dir) + args.output_dir = os.path.abspath(args.output_dir) + + if not os.path.isdir(args.src_dir): + sys.exit(args.src_dir + ' is not a directory.') + + if args.build_type != 'Debug' and args.build_type != 'Release': + sys.exit('Invalid build type: ' + args.build_type); + + if args.arch_type == 'x86': + vs_arch = '' + elif args.arch_type == 'x86_64': + vs_arch = ' Win64' + else: + sys.exit('Invalid arch type: ' + args.arch_type); + + if args.project_type == 'ninja': + generator = 'Ninja' + elif args.project_type == 'MSVS2013': + generator = 'Visual Studio 12 2013' + vs_arch + elif args.project_type == "MSVS2015": + generator = 'Visual Studio 14 2015' + vs_arch + else: + sys.exit('Invalid project type: ' + args.project_type); + + if not os.path.isdir(args.output_dir): + try: + os.makedirs(args.output_dir) + except os.error: + sys.exit('Error creating output dir ' + args.output_dir) + + try: + subprocess.check_call(['cmake', '-G', generator, + '-DSPIRV_SKIP_EXECUTABLES=ON', args.src_dir], cwd=args.output_dir) + except subprocess.CalledProcessError as error: + sys.exit('Error (ret code: {code}) calling "{cmd}" in {dir}'.format( + code = error.returncode, cmd = error.cmd, dir = args.src_dir)) + + try: + subprocess.check_call(['cmake', '--build', args.output_dir, '--config', + args.build_type], cwd=args.output_dir) + except subprocess.CalledProcessError as error: + sys.exit('Error (ret code: {code}) calling "{cmd}" in {dir}'.format( + code = error.returncode, cmd = error.cmd, dir = args.src_dir)) + +if __name__ == '__main__': + main() + -- cgit v1.2.3