diff options
| author | lucy96chen <47800040+lucy96chen@users.noreply.github.com> | 2022-10-12 09:55:09 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-12 09:55:09 -0700 |
| commit | f0cd62b37c5dfbbdb3fb205f1be2b8beba0dfed4 (patch) | |
| tree | 97d031e889046ac992b729d85e2db1cd3597e317 /source | |
| parent | 5128de89a9a8da09587f20e8fb5bc324ea14e0df (diff) | |
Shader caching (#2432)
* Changed all getEntryPointCode calls to use RendererBase::getEntryPointCodeFromShaderCache
* Hashing hooked up, tests pass but need to add more to fully test functionality
* checkpoint
* Checkpoint: File system creation seems functional, saving is broken
* checkpoint: Fixed filename generation from MD5 hash, shader blob might be going missing ahead of pipeline state creation
* Fixed a lot of bugs related to hash code generation, shader cache is likely working but needs further testing
* Added workaround for module loading by re-creating the test device, shader cache test functional
* Vulkan shader caching bug fixed, checkpoint commit before more refinement
* pre-ToT merge checkpoint
* checkpoint commit, improving cache keys
* Significantly expanded items included in the dependency hash for Module; Added dependency hash functions to SpecializedComponentType and RenamedEntryPointComponentType
* Temporarily disable shader cache test
* Mid cleanup changes, solution successfully builds
* Added several helper update functions to slang-md5 to help simplify usage; Added a function under ISession to compute a hash for all linkage-related items; Function renames and cleaned up some comments
* Ran premake.bat; Renamed getASTBasedHashCode to computeASTBasedHash
* Added slang unit tests for Checksum and MD5; Extended gfx shader cache test to test with multiple shader files and one shader file with multiple entry points
* Solution builds and shader cache tests pass, but at least a couple other tests now failing
* ran premake.bat
* More cleanup changes
* Added shaderCachePath field to IDevice desc in gfx.slang, gfx-smoke.slang should be functional
* ran premake
* cleanup changes; Adding test printf to getEntryPointCodeFromShaderCache to see if output can be seen in CI
* Removed debugging printfs; Added handling for getEntryPointCode() failing
* Cleanup changes; Jonathan's fixes to SerialWriter to zero initialize otherwise uninitialized memory; Change to SwizzleExpr creation to zero initialize elementCount
* Changed enable_if_t to enable_if
* Fixed enable_if
* Added test for import vs include and changes to included and imported files; Fixed build errors in CUDA; Renamed shader cache statistics fields
* cleanup changes
* Readd removed file
* Restructured computeDependencyBasedHash calls, added computeDependencyBasedHashImpl to all classes dervied from ComponentType
* Applied same restructuring to the AST hash functions
* Cleanup changes; Moved HashBuilder out to slang-digest.h and added some helper functions to streamline the process of adding items to a hash
* Cleanup; Fixed incorrect expected results for shader import and include test
Diffstat (limited to 'source')
| -rw-r--r-- | source/core/slang-digest.h | 31 | ||||
| -rw-r--r-- | source/core/slang-md5.cpp | 312 | ||||
| -rw-r--r-- | source/core/slang-md5.h | 82 | ||||
| -rw-r--r-- | source/slang/slang-ast-builder.h | 15 | ||||
| -rw-r--r-- | source/slang/slang-check-expr.cpp | 4 | ||||
| -rw-r--r-- | source/slang/slang-compiler.cpp | 24 | ||||
| -rwxr-xr-x | source/slang/slang-compiler.h | 119 | ||||
| -rw-r--r-- | source/slang/slang-hash-utils.h | 55 | ||||
| -rw-r--r-- | source/slang/slang-serialize-ast.cpp | 25 | ||||
| -rw-r--r-- | source/slang/slang-serialize-ast.h | 2 | ||||
| -rw-r--r-- | source/slang/slang-serialize-type-info.h | 12 | ||||
| -rw-r--r-- | source/slang/slang-serialize.cpp | 17 | ||||
| -rw-r--r-- | source/slang/slang-serialize.h | 25 | ||||
| -rw-r--r-- | source/slang/slang.cpp | 175 |
14 files changed, 885 insertions, 13 deletions
diff --git a/source/core/slang-digest.h b/source/core/slang-digest.h new file mode 100644 index 000000000..d1bc80b40 --- /dev/null +++ b/source/core/slang-digest.h @@ -0,0 +1,31 @@ +#pragma once +#include "slang-md5.h" +#include "../../slang.h" + +namespace Slang +{ + // Wrapper struct that holds objects necessary for hashing. + struct DigestBuilder + { + public: + DigestBuilder() + { + hashGen.init(&context); + } + + template <typename T> + void addToDigest(T item) + { + hashGen.update(&context, item); + } + + void finalize(slang::Digest* outHash) + { + hashGen.finalize(&context, outHash); + } + + private: + MD5HashGen hashGen; + MD5Context context; + }; +} diff --git a/source/core/slang-md5.cpp b/source/core/slang-md5.cpp new file mode 100644 index 000000000..95b4816bf --- /dev/null +++ b/source/core/slang-md5.cpp @@ -0,0 +1,312 @@ +/* + * This is an OpenSSL-compatible implementation of the RSA Data Security, Inc. + * MD5 Message-Digest Algorithm (RFC 1321). + * + * Homepage: + * http://openwall.info/wiki/people/solar/software/public-domain-source-code/md5 + * + * Author: + * Alexander Peslyak, better known as Solar Designer <solar at openwall.com> + * + * This software was written by Alexander Peslyak in 2001. No copyright is + * claimed, and the software is hereby placed in the public domain. + * In case this attempt to disclaim copyright and place the software in the + * public domain is deemed null and void, then the software is + * Copyright (c) 2001 Alexander Peslyak and it is hereby released to the + * general public under the following terms: + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted. + * + * There's ABSOLUTELY NO WARRANTY, express or implied. + * + * (This is a heavily cut-down "BSD license".) + * + * This differs from Colin Plumb's older public domain implementation in that + * no exactly 32-bit integer data type is required (any 32-bit or wider + * unsigned integer data type will do), there's no compile-time endianness + * configuration, and the function prototypes match OpenSSL's. No code from + * Colin Plumb's implementation has been reused; this comment merely compares + * the properties of the two independent implementations. + * + * The primary goals of this implementation are portability and ease of use. + * It is meant to be fast, but not as fast as possible. Some known + * optimizations are not included to reduce source code size and avoid + * compile-time configuration. + */ + +#ifndef HAVE_OPENSSL + +#include <string.h> + +#include "slang-md5.h" + +namespace Slang +{ + /* + * The basic MD5 functions. + * + * F and G are optimized compared to their RFC 1321 definitions for + * architectures that lack an AND-NOT instruction, just like in Colin Plumb's + * implementation. + */ + #define F(x, y, z) ((z) ^ ((x) & ((y) ^ (z)))) + #define G(x, y, z) ((y) ^ ((z) & ((x) ^ (y)))) + #define H(x, y, z) (((x) ^ (y)) ^ (z)) + #define H2(x, y, z) ((x) ^ ((y) ^ (z))) + #define I(x, y, z) ((y) ^ ((x) | ~(z))) + + /* + * The MD5 transformation for all four rounds. + */ + #define STEP(f, a, b, c, d, x, t, s) \ + (a) += f((b), (c), (d)) + (x) + (t); \ + (a) = (((a) << (s)) | (((a) & 0xffffffff) >> (32 - (s)))); \ + (a) += (b); + + /* + * SET reads 4 input bytes in little-endian byte order and stores them in a + * properly aligned word in host byte order. + * + * The check for little-endian architectures that tolerate unaligned memory + * accesses is just an optimization. Nothing will break if it fails to detect + * a suitable architecture. + * + * Unfortunately, this optimization may be a C strict aliasing rules violation + * if the caller's data buffer has effective type that cannot be aliased by + * MD5_u32plus. In practice, this problem may occur if these MD5 routines are + * inlined into a calling function, or with future and dangerously advanced + * link-time optimizations. For the time being, keeping these MD5 routines in + * their own translation unit avoids the problem. + */ + #if defined(__i386__) || defined(__x86_64__) || defined(__vax__) + #define SET(n) \ + (*(MD5_u32plus *)&ptr[(n) * 4]) + #define GET(n) \ + SET(n) + #else + #define SET(n) \ + (ctx->block[(n)] = \ + (MD5_u32plus)ptr[(n) * 4] | \ + ((MD5_u32plus)ptr[(n) * 4 + 1] << 8) | \ + ((MD5_u32plus)ptr[(n) * 4 + 2] << 16) | \ + ((MD5_u32plus)ptr[(n) * 4 + 3] << 24)) + #define GET(n) \ + (ctx->block[(n)]) + #endif + + /* + * This processes one or more 64-byte data blocks, but does NOT update the bit + * counters. There are no alignment requirements. + */ + /*static*/const void* MD5HashGen::body(MD5Context* ctx, const void* data, SlangInt size) + { + const unsigned char* ptr; + MD5_u32plus a, b, c, d; + MD5_u32plus saved_a, saved_b, saved_c, saved_d; + + ptr = (const unsigned char*)data; + + a = ctx->a; + b = ctx->b; + c = ctx->c; + d = ctx->d; + + do { + saved_a = a; + saved_b = b; + saved_c = c; + saved_d = d; + + /* Round 1 */ + STEP(F, a, b, c, d, SET(0), 0xd76aa478, 7) + STEP(F, d, a, b, c, SET(1), 0xe8c7b756, 12) + STEP(F, c, d, a, b, SET(2), 0x242070db, 17) + STEP(F, b, c, d, a, SET(3), 0xc1bdceee, 22) + STEP(F, a, b, c, d, SET(4), 0xf57c0faf, 7) + STEP(F, d, a, b, c, SET(5), 0x4787c62a, 12) + STEP(F, c, d, a, b, SET(6), 0xa8304613, 17) + STEP(F, b, c, d, a, SET(7), 0xfd469501, 22) + STEP(F, a, b, c, d, SET(8), 0x698098d8, 7) + STEP(F, d, a, b, c, SET(9), 0x8b44f7af, 12) + STEP(F, c, d, a, b, SET(10), 0xffff5bb1, 17) + STEP(F, b, c, d, a, SET(11), 0x895cd7be, 22) + STEP(F, a, b, c, d, SET(12), 0x6b901122, 7) + STEP(F, d, a, b, c, SET(13), 0xfd987193, 12) + STEP(F, c, d, a, b, SET(14), 0xa679438e, 17) + STEP(F, b, c, d, a, SET(15), 0x49b40821, 22) + + /* Round 2 */ + STEP(G, a, b, c, d, GET(1), 0xf61e2562, 5) + STEP(G, d, a, b, c, GET(6), 0xc040b340, 9) + STEP(G, c, d, a, b, GET(11), 0x265e5a51, 14) + STEP(G, b, c, d, a, GET(0), 0xe9b6c7aa, 20) + STEP(G, a, b, c, d, GET(5), 0xd62f105d, 5) + STEP(G, d, a, b, c, GET(10), 0x02441453, 9) + STEP(G, c, d, a, b, GET(15), 0xd8a1e681, 14) + STEP(G, b, c, d, a, GET(4), 0xe7d3fbc8, 20) + STEP(G, a, b, c, d, GET(9), 0x21e1cde6, 5) + STEP(G, d, a, b, c, GET(14), 0xc33707d6, 9) + STEP(G, c, d, a, b, GET(3), 0xf4d50d87, 14) + STEP(G, b, c, d, a, GET(8), 0x455a14ed, 20) + STEP(G, a, b, c, d, GET(13), 0xa9e3e905, 5) + STEP(G, d, a, b, c, GET(2), 0xfcefa3f8, 9) + STEP(G, c, d, a, b, GET(7), 0x676f02d9, 14) + STEP(G, b, c, d, a, GET(12), 0x8d2a4c8a, 20) + + /* Round 3 */ + STEP(H, a, b, c, d, GET(5), 0xfffa3942, 4) + STEP(H2, d, a, b, c, GET(8), 0x8771f681, 11) + STEP(H, c, d, a, b, GET(11), 0x6d9d6122, 16) + STEP(H2, b, c, d, a, GET(14), 0xfde5380c, 23) + STEP(H, a, b, c, d, GET(1), 0xa4beea44, 4) + STEP(H2, d, a, b, c, GET(4), 0x4bdecfa9, 11) + STEP(H, c, d, a, b, GET(7), 0xf6bb4b60, 16) + STEP(H2, b, c, d, a, GET(10), 0xbebfbc70, 23) + STEP(H, a, b, c, d, GET(13), 0x289b7ec6, 4) + STEP(H2, d, a, b, c, GET(0), 0xeaa127fa, 11) + STEP(H, c, d, a, b, GET(3), 0xd4ef3085, 16) + STEP(H2, b, c, d, a, GET(6), 0x04881d05, 23) + STEP(H, a, b, c, d, GET(9), 0xd9d4d039, 4) + STEP(H2, d, a, b, c, GET(12), 0xe6db99e5, 11) + STEP(H, c, d, a, b, GET(15), 0x1fa27cf8, 16) + STEP(H2, b, c, d, a, GET(2), 0xc4ac5665, 23) + + /* Round 4 */ + STEP(I, a, b, c, d, GET(0), 0xf4292244, 6) + STEP(I, d, a, b, c, GET(7), 0x432aff97, 10) + STEP(I, c, d, a, b, GET(14), 0xab9423a7, 15) + STEP(I, b, c, d, a, GET(5), 0xfc93a039, 21) + STEP(I, a, b, c, d, GET(12), 0x655b59c3, 6) + STEP(I, d, a, b, c, GET(3), 0x8f0ccc92, 10) + STEP(I, c, d, a, b, GET(10), 0xffeff47d, 15) + STEP(I, b, c, d, a, GET(1), 0x85845dd1, 21) + STEP(I, a, b, c, d, GET(8), 0x6fa87e4f, 6) + STEP(I, d, a, b, c, GET(15), 0xfe2ce6e0, 10) + STEP(I, c, d, a, b, GET(6), 0xa3014314, 15) + STEP(I, b, c, d, a, GET(13), 0x4e0811a1, 21) + STEP(I, a, b, c, d, GET(4), 0xf7537e82, 6) + STEP(I, d, a, b, c, GET(11), 0xbd3af235, 10) + STEP(I, c, d, a, b, GET(2), 0x2ad7d2bb, 15) + STEP(I, b, c, d, a, GET(9), 0xeb86d391, 21) + + a += saved_a; + b += saved_b; + c += saved_c; + d += saved_d; + + ptr += 64; + } while (size -= 64); + + ctx->a = a; + ctx->b = b; + ctx->c = c; + ctx->d = d; + + return ptr; + } + + void MD5HashGen::init(MD5Context* ctx) + { + ctx->a = 0x67452301; + ctx->b = 0xefcdab89; + ctx->c = 0x98badcfe; + ctx->d = 0x10325476; + + ctx->lo = 0; + ctx->hi = 0; + } + + void MD5HashGen::update(MD5Context* ctx, UnownedStringSlice string) + { + update(ctx, string.begin(), string.getLength()); + } + + void MD5HashGen::update(MD5Context* ctx, String str) + { + update(ctx, str.getBuffer(), str.getLength()); + } + + void MD5HashGen::update(MD5Context* ctx, const slang::Digest& hash) + { + update(ctx, hash.values, sizeof(hash.values)); + } + + void MD5HashGen::update(MD5Context* ctx, const void* data, SlangInt size) + { + MD5_u32plus saved_lo; + SlangInt used, available; + + saved_lo = ctx->lo; + if ((ctx->lo = (saved_lo + size) & 0x1fffffff) < saved_lo) + ctx->hi++; + ctx->hi += (MD5_u32plus)size >> 29; + + used = saved_lo & 0x3f; + + if (used) { + available = 64 - used; + + if (size < available) { + memcpy(&ctx->buffer[used], data, size); + return; + } + + memcpy(&ctx->buffer[used], data, available); + data = (const unsigned char*)data + available; + size -= available; + body(ctx, ctx->buffer, 64); + } + + if (size >= 64) { + data = body(ctx, data, size & ~(SlangInt)0x3f); + size &= 0x3f; + } + + memcpy(ctx->buffer, data, size); + } + + #define OUTUINT(dst, src) \ + (dst)[0] = (uint32_t)src; \ + + #define OUTCHAR(dst, src) \ + (dst)[0] = (unsigned char)(src); \ + (dst)[1] = (unsigned char)((src) >> 8); \ + (dst)[2] = (unsigned char)((src) >> 16); \ + (dst)[3] = (unsigned char)((src) >> 24); + + void MD5HashGen::finalize(MD5Context* ctx, slang::Digest* result) + { + unsigned long used, available; + + used = ctx->lo & 0x3f; + + ctx->buffer[used++] = 0x80; + + available = 64 - used; + + if (available < 8) { + memset(&ctx->buffer[used], 0, available); + body(ctx, ctx->buffer, 64); + used = 0; + available = 64; + } + + memset(&ctx->buffer[used], 0, available - 8); + + ctx->lo <<= 3; + OUTCHAR(&ctx->buffer[56], ctx->lo) + OUTCHAR(&ctx->buffer[60], ctx->hi) + + body(ctx, ctx->buffer, 64); + + OUTUINT(&result->values[0], ctx->a) + OUTUINT(&result->values[1], ctx->b) + OUTUINT(&result->values[2], ctx->c) + OUTUINT(&result->values[3], ctx->d) + + memset(ctx, 0, sizeof(*ctx)); + } +} + +#endif diff --git a/source/core/slang-md5.h b/source/core/slang-md5.h new file mode 100644 index 000000000..8c51a03ec --- /dev/null +++ b/source/core/slang-md5.h @@ -0,0 +1,82 @@ +/* + * This is an OpenSSL-compatible implementation of the RSA Data Security, Inc. + * MD5 Message-Digest Algorithm (RFC 1321). + * + * Homepage: + * http://openwall.info/wiki/people/solar/software/public-domain-source-code/md5 + * + * Author: + * Alexander Peslyak, better known as Solar Designer <solar at openwall.com> + * + * This software was written by Alexander Peslyak in 2001. No copyright is + * claimed, and the software is hereby placed in the public domain. + * In case this attempt to disclaim copyright and place the software in the + * public domain is deemed null and void, then the software is + * Copyright (c) 2001 Alexander Peslyak and it is hereby released to the + * general public under the following terms: + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted. + * + * There's ABSOLUTELY NO WARRANTY, express or implied. + * + * See md5.c for more information. + */ + +#ifdef HAVE_OPENSSL +#include <openssl/md5.h> +#elif !defined(_MD5_H) +#define _MD5_H + +#pragma once +#include "../../slang.h" +#include "../core/slang-string.h" +#include "../core/slang-list.h" + +namespace Slang +{ + /* Any 32-bit or wider unsigned integer data type will do */ + typedef uint32_t MD5_u32plus; + + struct MD5Context + { + MD5_u32plus lo, hi; + MD5_u32plus a, b, c, d; + unsigned char buffer[64]; + MD5_u32plus block[16]; + }; + + class MD5HashGen + { + public: + void init(MD5Context* ctx); + + // Helper update function for raw values (e.g. ints, uints) + template<typename T, + typename = typename std::enable_if<std::is_enum<T>::value || std::is_arithmetic<T>::value>::type> + void update(MD5Context* ctx, const T& val) + { + update(ctx, &val, sizeof(T)); + } + // Helper update function for Slang::List + template<typename T> + void update(MD5Context* ctx, const List<T>& list) + { + update(ctx, list.getBuffer(), list.getCount()); + } + // Helper update function for UnownedStringSlice + void update(MD5Context* ctx, UnownedStringSlice string); + // Helper update function for Slang::String + void update(MD5Context* ctx, String str); + // Helper update function for Checksums + void update(MD5Context* ctx, const slang::Digest& checksum); + + void finalize(MD5Context* ctx, slang::Digest* result); + + private: + static const void* body(MD5Context* ctx, const void* data, SlangInt size); + void update(MD5Context* ctx, const void* data, SlangInt size); + }; +} + +#endif diff --git a/source/slang/slang-ast-builder.h b/source/slang/slang-ast-builder.h index 3023e274d..91fe63c88 100644 --- a/source/slang/slang-ast-builder.h +++ b/source/slang/slang-ast-builder.h @@ -155,9 +155,20 @@ public: /// Create AST types template <typename T> - T* create() { return _initAndAdd(new (m_arena.allocate(sizeof(T))) T); } + T* create() + { + auto alloced = m_arena.allocate(sizeof(T)); + memset(alloced, 0, sizeof(T)); + return _initAndAdd(new (alloced) T); + } + template<typename T, typename... TArgs> - T* create(TArgs... args) { return _initAndAdd(new (m_arena.allocate(sizeof(T))) T(args...)); } + T* create(TArgs... args) + { + auto alloced = m_arena.allocate(sizeof(T)); + memset(alloced, 0, sizeof(T)); + return _initAndAdd(new (alloced) T(args...)); + } template<typename T, typename ... TArgs> SLANG_FORCE_INLINE T* getOrCreate(TArgs ... args) diff --git a/source/slang/slang-check-expr.cpp b/source/slang/slang-check-expr.cpp index 2987fecee..f1ccddf15 100644 --- a/source/slang/slang-check-expr.cpp +++ b/source/slang/slang-check-expr.cpp @@ -2195,6 +2195,10 @@ namespace Slang SwizzleExpr* swizExpr = m_astBuilder->create<SwizzleExpr>(); swizExpr->loc = memberRefExpr->loc; swizExpr->base = memberRefExpr->baseExpression; + swizExpr->elementIndices[0] = 0; + swizExpr->elementIndices[1] = 0; + swizExpr->elementIndices[2] = 0; + swizExpr->elementIndices[3] = 0; swizExpr->memberOpLoc = memberRefExpr->memberOperatorLoc; IntegerLiteralValue limitElement = baseElementCount; diff --git a/source/slang/slang-compiler.cpp b/source/slang/slang-compiler.cpp index 06cc9d759..889ecc58a 100644 --- a/source/slang/slang-compiler.cpp +++ b/source/slang/slang-compiler.cpp @@ -35,6 +35,7 @@ #include "slang-glsl-extension-tracker.h" #include "slang-emit-cuda.h" +#include "slang-serialize-ast.h" #include "slang-serialize-container.h" namespace Slang @@ -222,6 +223,16 @@ namespace Slang visitor->visitEntryPoint(this, as<EntryPointSpecializationInfo>(specializationInfo)); } + void EntryPoint::updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt entryPointIndex) + { + // CompositeComponentType will have already hashed the relevant entry point's name + // and file path dependencies, so we immediately return. + SLANG_UNUSED(builder); + SLANG_UNUSED(entryPointIndex); + } + List<Module*> const& EntryPoint::getModuleDependencies() { if(auto module = getModule()) @@ -290,6 +301,19 @@ namespace Slang return Super::getInterface(guid); } + void TypeConformance::updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt entryPointIndex) + { + SLANG_UNUSED(entryPointIndex); + + //TODO: Implement some kind of hashInto for Val then replace this + auto subtypeWitness = m_subtypeWitness->toString(); + + builder.addToDigest(subtypeWitness); + builder.addToDigest(m_conformanceIdOverride); + } + List<Module*> const& TypeConformance::getModuleDependencies() { return m_moduleDependency.getModuleList(); diff --git a/source/slang/slang-compiler.h b/source/slang/slang-compiler.h index 46be07fa3..016c8fefa 100755 --- a/source/slang/slang-compiler.h +++ b/source/slang/slang-compiler.h @@ -3,6 +3,7 @@ #include "../core/slang-basic.h" #include "../core/slang-shared-library.h" +#include "../core/slang-digest.h" #include "../compiler-core/slang-downstream-compiler.h" #include "../compiler-core/slang-downstream-compiler-util.h" @@ -282,14 +283,23 @@ namespace Slang const char* newName, slang::IComponentType** outEntryPoint) SLANG_OVERRIDE; SLANG_NO_THROW SlangResult SLANG_MCALL link( - slang::IComponentType** outLinkedComponentType, - ISlangBlob** outDiagnostics) SLANG_OVERRIDE; + slang::IComponentType** outLinkedComponentType, + ISlangBlob** outDiagnostics) SLANG_OVERRIDE; SLANG_NO_THROW SlangResult SLANG_MCALL getEntryPointHostCallable( int entryPointIndex, int targetIndex, ISlangSharedLibrary** outSharedLibrary, slang::IBlob** outDiagnostics) SLANG_OVERRIDE; + /// ComponentType is the only class inheriting from IComponentType that provides a + /// meaningful implementation for these two functions. All others should forward these + /// and implement updateDependencyBasedHash and updateASTBasedHash instead. + SLANG_NO_THROW void SLANG_MCALL computeDependencyBasedHash( + SlangInt entryPointIndex, + SlangInt targetIndex, + slang::Digest* outHash) SLANG_OVERRIDE; + SLANG_NO_THROW void SLANG_MCALL computeASTBasedHash(slang::Digest* outHash) SLANG_OVERRIDE; + /// Get the linkage (aka "session" in the public API) for this component type. Linkage* getLinkage() { return m_linkage; } @@ -298,6 +308,16 @@ namespace Slang /// The `target` must be a target on the `Linkage` that was used to create this program. TargetProgram* getTargetProgram(TargetRequest* target); + /// Update the hash builder with the dependencies for this component type. + virtual void updateDependencyBasedHash( + DigestBuilder& hashBuilder, + SlangInt entryPointIndex) = 0; + + /// Update the hash builder with the AST contents for this component type. + /// The AST is associated with a Module component, so most derived ComponentType classes + /// will simply do nothing with this. + virtual void updateASTBasedHash(DigestBuilder& hashBuilder) = 0; + /// Get the number of entry points linked into this component type. virtual Index getEntryPointCount() = 0; @@ -495,6 +515,12 @@ namespace Slang Linkage* linkage, List<RefPtr<ComponentType>> const& childComponents); + virtual void updateDependencyBasedHash( + DigestBuilder& hashBuilder, + SlangInt entryPointIndex) override; + + virtual void updateASTBasedHash(DigestBuilder& hashBuilder) override; + List<RefPtr<ComponentType>> const& getChildComponents() { return m_childComponents; }; Index getChildComponentCount() { return m_childComponents.getCount(); } RefPtr<ComponentType> getChildComponent(Index index) { return m_childComponents[index]; } @@ -571,6 +597,15 @@ namespace Slang List<SpecializationArg> const& specializationArgs, DiagnosticSink* sink); + virtual void updateDependencyBasedHash( + DigestBuilder& hashBuilder, + SlangInt entryPointIndex) override; + + virtual void updateASTBasedHash(DigestBuilder& hashBuilder) override + { + SLANG_UNUSED(hashBuilder); + } + /// Get the base (unspecialized) component type that is being specialized. RefPtr<ComponentType> getBaseComponentType() { return m_base; } @@ -754,6 +789,16 @@ namespace Slang void acceptVisitor(ComponentTypeVisitor* visitor, SpecializationInfo* specializationInfo) SLANG_OVERRIDE; + + virtual void updateDependencyBasedHash( + DigestBuilder& hashBuilder, + SlangInt entryPointIndex) override; + + virtual void updateASTBasedHash(DigestBuilder& hashBuilder) override + { + SLANG_UNUSED(hashBuilder); + } + private: RefPtr<ComponentType> m_base; String m_entryPointNameOverride; @@ -846,6 +891,28 @@ namespace Slang return Super::getEntryPointHostCallable(entryPointIndex, targetIndex, outSharedLibrary, outDiagnostics); } + SLANG_NO_THROW void SLANG_MCALL computeDependencyBasedHash( + SlangInt entryPointIndex, + SlangInt targetIndex, + slang::Digest* outHash) SLANG_OVERRIDE + { + return Super::computeDependencyBasedHash(entryPointIndex, targetIndex, outHash); + } + + SLANG_NO_THROW void SLANG_MCALL computeASTBasedHash(slang::Digest* outHash) + { + return Super::computeASTBasedHash(outHash); + } + + virtual void updateDependencyBasedHash( + DigestBuilder& hashBuilder, + SlangInt entryPointIndex) override; + + virtual void updateASTBasedHash(DigestBuilder& hashBuilder) override + { + SLANG_UNUSED(hashBuilder); + } + /// Create an entry point that refers to the given function. static RefPtr<EntryPoint> create( Linkage* linkage, @@ -1051,6 +1118,28 @@ namespace Slang entryPointIndex, targetIndex, outSharedLibrary, outDiagnostics); } + SLANG_NO_THROW void SLANG_MCALL computeDependencyBasedHash( + SlangInt entryPointIndex, + SlangInt targetIndex, + slang::Digest* outHash) SLANG_OVERRIDE + { + return Super::computeDependencyBasedHash(entryPointIndex, targetIndex, outHash); + } + + SLANG_NO_THROW void SLANG_MCALL computeASTBasedHash(slang::Digest* outHash) + { + return Super::computeASTBasedHash(outHash); + } + + virtual void updateDependencyBasedHash( + DigestBuilder& hashBuilder, + SlangInt entryPointIndex) override; + + virtual void updateASTBasedHash(DigestBuilder& hashBuilder) override + { + SLANG_UNUSED(hashBuilder); + } + List<Module*> const& getModuleDependencies() SLANG_OVERRIDE; List<String> const& getFilePathDependencies() SLANG_OVERRIDE; @@ -1225,6 +1314,25 @@ namespace Slang // + SLANG_NO_THROW void SLANG_MCALL computeDependencyBasedHash( + SlangInt entryPointIndex, + SlangInt targetIndex, + slang::Digest* outHash) SLANG_OVERRIDE + { + return Super::computeDependencyBasedHash(entryPointIndex, targetIndex, outHash); + } + + SLANG_NO_THROW void SLANG_MCALL computeASTBasedHash(slang::Digest* outHash) + { + return Super::computeASTBasedHash(outHash); + } + + virtual void updateDependencyBasedHash( + DigestBuilder& hashBuilder, + SlangInt entryPointIndex) override; + + virtual void updateASTBasedHash(DigestBuilder& hashBuilder) override; + /// Create a module (initially empty). Module(Linkage* linkage, ASTBuilder* astBuilder = nullptr); @@ -1657,6 +1765,13 @@ namespace Slang SLANG_NO_THROW SlangResult SLANG_MCALL createCompileRequest( SlangCompileRequest** outCompileRequest) override; + // Updates the supplied has builder with linkage-related information, which includes preprocessor + // defines, the compiler version, and other compiler options. This is then merged with the hash + // produced for the program to produce a key that can be used with the shader cache. + void updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt targetIndex); + void addTarget( slang::TargetDesc const& desc); SlangResult addSearchPath( diff --git a/source/slang/slang-hash-utils.h b/source/slang/slang-hash-utils.h new file mode 100644 index 000000000..d0d610cb8 --- /dev/null +++ b/source/slang/slang-hash-utils.h @@ -0,0 +1,55 @@ +// slang-hash-utils.h - Utility functions specifically designed to be used with slang::Digest +#pragma once +#include "../../slang.h" +#include "../core/slang-basic.h" +#include "../core/slang-md5.h" +#include "../core/slang-digest.h" + +namespace Slang +{ + // Compute the hash for an UnownedStringSlice + inline slang::Digest computeHashForStringSlice(UnownedStringSlice text) + { + DigestBuilder builder; + builder.addToDigest(text); + + slang::Digest textHash; + builder.finalize(&textHash); + + return textHash; + } + + // Combines the two provided hashes. + inline slang::Digest combineHashes(const slang::Digest& hashA, const slang::Digest& hashB) + { + DigestBuilder builder; + builder.addToDigest(hashA); + builder.addToDigest(hashB); + + slang::Digest combined; + builder.finalize(&combined); + return combined; + } + + // Returns the stored hash in checksum as a String. + inline StringBuilder hashToString(const slang::Digest& hash) + { + StringBuilder filename; + + for (Index i = 0; i < 4; ++i) + { + auto hashSegmentString = String(hash.values[i], 16); + + auto leadingZeroCount = 8 - hashSegmentString.getLength(); + for (Index j = 0; j < leadingZeroCount; ++j) + { + filename.append("0"); + } + filename.append(hashSegmentString.getBuffer()); + } + + return filename; + } + + // TODO: fromString implementation? +} diff --git a/source/slang/slang-serialize-ast.cpp b/source/slang/slang-serialize-ast.cpp index 31a3f6ac0..04b5f71b1 100644 --- a/source/slang/slang-serialize-ast.cpp +++ b/source/slang/slang-serialize-ast.cpp @@ -154,4 +154,29 @@ struct ASTFieldAccess return SLANG_OK; } +/* static */List<uint8_t> ASTSerialUtil::serializeAST(ModuleDecl* moduleDecl) +{ + //TODO: we should store `classes` in GlobalSession to avoid recomputing them every time. + RefPtr<SerialClasses> classes; + SerialClassesUtil::create(classes); + + List<uint8_t> contents; + OwnedMemoryStream stream(FileAccess::ReadWrite); + + // Only serialize out things *in* this module + ModuleSerialFilter filterStorage(moduleDecl); + + SerialFilter* filter = moduleDecl ? &filterStorage : nullptr; + + SerialWriter writer(classes, filter); + + // Lets serialize it all + writer.addPointer(moduleDecl); + // Let's stick it all in a stream + writer.write(&stream); + + stream.swapContents(contents); + return contents; +} + } // namespace Slang diff --git a/source/slang/slang-serialize-ast.h b/source/slang/slang-serialize-ast.h index 3aa790c86..1052c9a0a 100644 --- a/source/slang/slang-serialize-ast.h +++ b/source/slang/slang-serialize-ast.h @@ -48,6 +48,8 @@ struct ASTSerialUtil /// Tries to serialize out, read back in and test the results are the same. /// Will write dumped out node to files static SlangResult testSerialize(NodeBase* node, RootNamePool* rootNamePool, SharedASTBuilder* sharedASTBuilder, SourceManager* sourceManager); + + static List<uint8_t> serializeAST(ModuleDecl* moduleDecl); }; } // namespace Slang diff --git a/source/slang/slang-serialize-type-info.h b/source/slang/slang-serialize-type-info.h index c80eb8051..6258a129d 100644 --- a/source/slang/slang-serialize-type-info.h +++ b/source/slang/slang-serialize-type-info.h @@ -104,6 +104,12 @@ struct SerialTypeInfo<T[N]> static void toSerial(SerialWriter* writer, const void* inNative, void* outSerial) { SerialElementType* serial = (SerialElementType*)outSerial; + + if (writer->getFlags() & SerialWriter::Flag::ZeroInitialize) + { + ::memset(outSerial, 0, sizeof(SerialElementType) * N); + } + const T* native = (const T*)inNative; for (Index i = 0; i < Index(N); ++i) { @@ -278,6 +284,12 @@ struct SerialTypeInfo<Dictionary<KEY, VALUE>> keys.setCount(count); values.setCount(count); + if (writer->getFlags() & SerialWriter::Flag::ZeroInitialize) + { + ::memset(keys.getBuffer(), 0, count * sizeof(KeySerialType)); + ::memset(values.getBuffer(), 0, count * sizeof(ValueSerialType)); + } + Index i = 0; for (const auto& pair : src) { diff --git a/source/slang/slang-serialize.cpp b/source/slang/slang-serialize.cpp index 71ef303b7..9b63d47c5 100644 --- a/source/slang/slang-serialize.cpp +++ b/source/slang/slang-serialize.cpp @@ -210,10 +210,11 @@ SerialClasses::SerialClasses(): // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! SerialWriter !!!!!!!!!!!!!!!!!!!!!!!!!!!! -SerialWriter::SerialWriter(SerialClasses* classes, SerialFilter* filter) : - m_arena(2048), - m_classes(classes), - m_filter(filter) +SerialWriter::SerialWriter(SerialClasses* classes, SerialFilter* filter, Flags flags) + : m_arena(2048) + , m_classes(classes) + , m_filter(filter) + , m_flags(flags) { // 0 is always the null pointer m_entries.add(nullptr); @@ -236,6 +237,7 @@ SerialIndex SerialWriter::writeObject(const SerialClass* serialCls, const void* nodeEntry->typeKind = serialCls->typeKind; nodeEntry->subType = serialCls->subType; + nodeEntry->_pad0 = 0; nodeEntry->info = SerialInfo::makeEntryInfo(serialCls->alignment); @@ -244,6 +246,12 @@ SerialIndex SerialWriter::writeObject(const SerialClass* serialCls, const void* // Point to start of payload uint8_t* serialPayload = (uint8_t*)(nodeEntry + 1); + + if (m_flags & Flag::ZeroInitialize) + { + ::memset(serialPayload, 0, serialCls->size); + } + while (serialCls) { for (Index i = 0; i < serialCls->fieldsCount; ++i) @@ -483,6 +491,7 @@ SlangResult SerialWriter::write(Stream* stream) for (Index i = 1; i < entriesCount; ++i) { SerialInfo::Entry* next = entries[i + 1]; + // Before writing we need to store the next alignment const size_t nextAlignment = SerialInfo::getAlignment(next->info); diff --git a/source/slang/slang-serialize.h b/source/slang/slang-serialize.h index fcd2daa1f..e08d26dd5 100644 --- a/source/slang/slang-serialize.h +++ b/source/slang/slang-serialize.h @@ -316,6 +316,18 @@ void SerialReader::getArray(SerialIndex index, List<T>& out) class SerialWriter : public RefObject { public: + typedef uint32_t Flags; + struct Flag + { + enum Enum : Flags + { + /// If set will zero initialize backing memory. This is slower but + /// is desirable to make two serializations of the same thing produce the + /// identical serialized result. + ZeroInitialize = 0x1 + }; + }; + SerialIndex addPointer(const NodeBase* ptr); SerialIndex addPointer(const RefObject* ptr); @@ -367,8 +379,11 @@ public: /// Used for attaching extra objects necessary for serializing SerialExtraObjects& getExtraObjects() { return m_extraObjects; } + /// Get the flag + Flags getFlags() const { return m_flags; } + /// Ctor - SerialWriter(SerialClasses* classes, SerialFilter* filter); + SerialWriter(SerialClasses* classes, SerialFilter* filter, Flags flags = Flag::ZeroInitialize); protected: @@ -388,7 +403,6 @@ protected: Dictionary<const void*, Index> m_ptrMap; // Maps a pointer to an entry index - // NOTE! Assumes the content stays in scope! SliceMap m_sliceMap; SliceMap m_importSymbolMap; @@ -399,6 +413,8 @@ protected: MemoryArena m_arena; ///< Holds the payloads SerialClasses* m_classes; SerialFilter* m_filter; ///< Filter to control what is serialized + + Flags m_flags; ///< Flags to control behavior }; // --------------------------------------------------------------------------- @@ -419,6 +435,11 @@ SerialIndex SerialWriter::addArray(const T* in, Index count) List<ElementSerialType> work; work.setCount(count); + if (getFlags() & Flag::ZeroInitialize) + { + ::memset(work.getBuffer(), 0, sizeof(ElementSerialType) * count); + } + for (Index i = 0; i < count; ++i) { ElementTypeInfo::toSerial(this, &in[i], &work[i]); diff --git a/source/slang/slang.cpp b/source/slang/slang.cpp index a3fd91ce0..a6dcf8ab2 100644 --- a/source/slang/slang.cpp +++ b/source/slang/slang.cpp @@ -44,6 +44,9 @@ #include "slang-check-impl.h" +#include "../core/slang-md5.h" +#include "slang-hash-utils.h" + #include "../../slang-tag-version.h" // Used to print exception type names in internal-compiler-error messages @@ -1318,6 +1321,54 @@ SLANG_NO_THROW SlangResult SLANG_MCALL Linkage::createCompileRequest( return SLANG_OK; } +void Linkage::updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt targetIndex) +{ + // Add the Slang compiler version to the hash + auto version = String(getBuildTagString()); + builder.addToDigest(version); + + // Add the search directory paths to the hash + auto searchDirectoryList = getSearchDirectories().searchDirectories; + for (auto& searchDir : searchDirectoryList) + { + auto searchPath = searchDir.path; + builder.addToDigest(searchPath); + } + + // Add the preprocessor definitions to the hash + for (auto& key : preprocessorDefinitions) + { + builder.addToDigest(key.Key); + builder.addToDigest(key.Value); + } + + // Add the target specified by targetIndex + auto targetReq = targets[targetIndex]; + builder.addToDigest(targetReq->getTarget()); + builder.addToDigest(targetReq->getTargetFlags()); + builder.addToDigest(targetReq->getFloatingPointMode()); + builder.addToDigest(targetReq->getLineDirectiveMode()); + builder.addToDigest(targetReq->shouldDumpIntermediates()); + builder.addToDigest(targetReq->getForceGLSLScalarBufferLayout()); + builder.addToDigest(targetReq->shouldTrackLiveness()); + + auto targetProfile = targetReq->getTargetProfile(); + builder.addToDigest(targetProfile.getStage()); + builder.addToDigest(targetProfile.getVersion()); + builder.addToDigest(targetProfile.getFamily()); + + auto targetProfileName = String(targetProfile.getName()); + builder.addToDigest(targetProfileName); + + auto cookedCapabilities = targetReq->getTargetCaps().getExpandedAtoms(); + for (auto& capability : cookedCapabilities) + { + builder.addToDigest(capability); + } +} + SlangResult Linkage::addSearchPath( char const* path) { @@ -1618,10 +1669,20 @@ void TranslationUnitRequest::_addSourceFile(SourceFile* sourceFile) // an associated path and/or wasn't from a file. auto pathInfo = sourceFile->getPathInfo(); - if (pathInfo.hasFileFoundPath()) + if (pathInfo.hasFoundPath()) { getModule()->addFilePathDependency(pathInfo.foundPath); } + else + { + // No path exists for this source, so we generate a new string to use as a + // fake path in the list of file path dependencies. This is needed to account + // for non-file-based dependencies later when shader files are being hashed for + // the shader cache. + + slang::Digest sourceHash = computeHashForStringSlice(sourceFile->getContent()); + getModule()->addFilePathDependency(hashToString(sourceHash)); + } } List<SourceFile*> const& TranslationUnitRequest::getSourceFiles() @@ -3149,8 +3210,6 @@ void FilePathDependencyList::addDependency(Module* module) } } - - // // Module // @@ -3178,6 +3237,22 @@ ISlangUnknown* Module::getInterface(const Guid& guid) return Super::getInterface(guid); } +void Module::updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt entryPointIndex) +{ + // CompositeComponentType will have already hashed this Module's file + // dependencies. + SLANG_UNUSED(builder); + SLANG_UNUSED(entryPointIndex); +} + +void Module::updateASTBasedHash(DigestBuilder& builder) +{ + auto serializedAST = ASTSerialUtil::serializeAST(getModuleDecl()); + builder.addToDigest(serializedAST); +} + void Module::addModuleDependency(Module* module) { m_moduleDependencyList.addDependency(module); @@ -3376,6 +3451,52 @@ SLANG_NO_THROW SlangResult SLANG_MCALL ComponentType::getEntryPointCode( return artifact->loadBlob(ArtifactKeep::Yes, outCode); } +SLANG_NO_THROW void SLANG_MCALL ComponentType::computeDependencyBasedHash( + SlangInt entryPointIndex, + SlangInt targetIndex, + slang::Digest* outHash) +{ + DigestBuilder builder; + + // A note on enums that may be hashed in as part of the following two function calls: + // + // While enums are not guaranteed to be encoded the same way across all versions of + // the compiler, part of hashing the linkage is hashing in the compiler version. + // Consequently, any encoding differences as a result of different compiler versions + // will already be reflected in the resulting hash. + getLinkage()->updateDependencyBasedHash(builder, targetIndex); + updateDependencyBasedHash(builder, entryPointIndex); + + // Add file path dependencies to the hash - all child components + // will have file path dependencies that are a subset of this list. + auto fileDeps = getFilePathDependencies(); + for (auto& file : fileDeps) + { + builder.addToDigest(file); + } + + // Add the name and name override for the specified entry point + // to the hash. + auto entryPointName = getEntryPoint(entryPointIndex)->getName()->text; + builder.addToDigest(entryPointName); + auto entryPointNameOverride = getEntryPointNameOverride(entryPointIndex); + builder.addToDigest(entryPointNameOverride); + + slang::Digest hash; + builder.finalize(&hash); + *outHash = hash; +} + +SLANG_NO_THROW void SLANG_MCALL ComponentType::computeASTBasedHash(slang::Digest* outHash) +{ + DigestBuilder builder; + updateASTBasedHash(builder); + + slang::Digest hash; + builder.finalize(&hash); + *outHash = hash; +} + SLANG_NO_THROW SlangResult SLANG_MCALL ComponentType::getEntryPointHostCallable( int entryPointIndex, int targetIndex, @@ -3708,6 +3829,28 @@ CompositeComponentType::CompositeComponentType( } } +void CompositeComponentType::updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt entryPointIndex) +{ + auto componentCount = getChildComponentCount(); + + for (Index i = 0; i < componentCount; ++i) + { + getChildComponent(i)->updateDependencyBasedHash(builder, entryPointIndex); + } +} + +void CompositeComponentType::updateASTBasedHash(DigestBuilder& builder) +{ + auto componentCount = getChildComponentCount(); + + for (Index i = 0; i < componentCount; ++i) + { + getChildComponent(i)->updateASTBasedHash(builder); + } +} + Index CompositeComponentType::getEntryPointCount() { return m_entryPoints.getCount(); @@ -4187,6 +4330,22 @@ SpecializedComponentType::SpecializedComponentType( collector.visitSpecialized(this); } +void SpecializedComponentType::updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt entryPointIndex) +{ + auto specializationArgCount = getSpecializationArgCount(); + for (Index i = 0; i < specializationArgCount; ++i) + { + auto specializationArg = getSpecializationArg(i); + auto argString = specializationArg.val->toString(); + builder.addToDigest(argString); + } + + slang::Digest baseHash; + getBaseComponentType()->updateDependencyBasedHash(builder, entryPointIndex); +} + void SpecializedComponentType::acceptVisitor(ComponentTypeVisitor* visitor, SpecializationInfo* specializationInfo) { SLANG_ASSERT(specializationInfo == nullptr); @@ -4231,6 +4390,16 @@ void RenamedEntryPointComponentType::acceptVisitor( this, as<EntryPoint::EntryPointSpecializationInfo>(specializationInfo)); } +void RenamedEntryPointComponentType::updateDependencyBasedHash( + DigestBuilder& builder, + SlangInt entryPointIndex) +{ + // CompositeComponentType will have already hashed the name override and file + // dependencies for this entry point. + SLANG_UNUSED(entryPointIndex); + SLANG_UNUSED(builder); +} + void ComponentTypeVisitor::visitChildren(CompositeComponentType* composite, CompositeComponentType::CompositeSpecializationInfo* specializationInfo) { auto childCount = composite->getChildComponentCount(); |
