blob: a6a16f06ab6d023d95e76ccf22b0e38054374e46 [file] [log] [blame]
joshualitt30ba4362014-08-21 20:18:45 -07001/*
2 * Copyright 2014 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
Mike Kleinc0bd9f92019-04-23 12:05:21 -05008#include "src/gpu/gl/builders/GrGLProgramBuilder.h"
joshualitt8072caa2015-02-12 14:20:52 -08009
Mike Kleinc0bd9f92019-04-23 12:05:21 -050010#include "include/gpu/GrContext.h"
11#include "src/core/SkATrace.h"
12#include "src/core/SkAutoMalloc.h"
13#include "src/core/SkReader32.h"
14#include "src/core/SkTraceEvent.h"
15#include "src/core/SkWriter32.h"
16#include "src/gpu/GrAutoLocaleSetter.h"
17#include "src/gpu/GrContextPriv.h"
18#include "src/gpu/GrCoordTransform.h"
19#include "src/gpu/GrPersistentCacheUtils.h"
20#include "src/gpu/GrProgramDesc.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050021#include "src/gpu/GrShaderCaps.h"
Brian Osmanac9be9d2019-05-01 10:29:34 -040022#include "src/gpu/GrShaderUtils.h"
Brian Salomon3ec1f542019-06-17 17:54:57 +000023#include "src/gpu/GrSwizzle.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050024#include "src/gpu/gl/GrGLGpu.h"
25#include "src/gpu/gl/GrGLProgram.h"
26#include "src/gpu/gl/builders/GrGLProgramBuilder.h"
27#include "src/gpu/gl/builders/GrGLShaderStringBuilder.h"
28#include "src/gpu/glsl/GrGLSLFragmentProcessor.h"
29#include "src/gpu/glsl/GrGLSLGeometryProcessor.h"
30#include "src/gpu/glsl/GrGLSLProgramDataManager.h"
31#include "src/gpu/glsl/GrGLSLXferProcessor.h"
joshualitt30ba4362014-08-21 20:18:45 -070032
joshualitt30ba4362014-08-21 20:18:45 -070033#define GL_CALL(X) GR_GL_CALL(this->gpu()->glInterface(), X)
34#define GL_CALL_RET(R, X) GR_GL_CALL_RET(this->gpu()->glInterface(), R, X)
35
Brian Osmaned58e002019-09-06 14:42:43 -040036static void cleanup_shaders(GrGLGpu* gpu, const SkTDArray<GrGLuint>& shaderIDs) {
37 for (int i = 0; i < shaderIDs.count(); ++i) {
38 GR_GL_CALL(gpu->glInterface(), DeleteShader(shaderIDs[i]));
39 }
40}
41
42static void cleanup_program(GrGLGpu* gpu, GrGLuint programID,
43 const SkTDArray<GrGLuint>& shaderIDs) {
44 GR_GL_CALL(gpu->glInterface(), DeleteProgram(programID));
45 cleanup_shaders(gpu, shaderIDs);
46}
47
Stephen Whiteb1857852020-02-07 15:33:23 +000048sk_sp<GrGLProgram> GrGLProgramBuilder::CreateProgram(
Austin Eng77fdf662020-02-07 01:26:16 +000049 GrGLGpu* gpu,
Stephen Whiteb1857852020-02-07 15:33:23 +000050 GrRenderTarget* renderTarget,
51 const GrProgramDesc& desc,
52 const GrProgramInfo& programInfo,
Brian Osmaned58e002019-09-06 14:42:43 -040053 const GrGLPrecompiledProgram* precompiledProgram) {
Stan Iliev43324e72020-01-13 16:17:48 -050054 ATRACE_ANDROID_FRAMEWORK_ALWAYS("shader_compile");
bsalomon3318ee72015-03-16 11:56:29 -070055 GrAutoLocaleSetter als("C");
56
joshualitt47bb3822014-10-07 16:43:25 -070057 // create a builder. This will be handed off to effects so they can use it to add
58 // uniforms, varyings, textures, etc
Stephen Whiteb1857852020-02-07 15:33:23 +000059 GrGLProgramBuilder builder(gpu, renderTarget, desc, programInfo);
joshualitt47bb3822014-10-07 16:43:25 -070060
Robert Phillips9da87e02019-02-04 13:26:26 -050061 auto persistentCache = gpu->getContext()->priv().getPersistentCache();
Brian Osmaned58e002019-09-06 14:42:43 -040062 if (persistentCache && !precompiledProgram) {
Stephen Whiteb1857852020-02-07 15:33:23 +000063 sk_sp<SkData> key = SkData::MakeWithoutCopy(desc.asKey(), desc.keyLength());
Robert Phillips0c4b7b12018-03-06 08:20:37 -050064 builder.fCached = persistentCache->load(*key);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -040065 // the eventual end goal is to completely skip emitAndInstallProcs on a cache hit, but it's
66 // doing necessary setup in addition to generating the SkSL code. Currently we are only able
67 // to skip the SkSL->GLSL step on a cache hit.
68 }
Ethan Nicholas2983f402017-05-08 09:36:08 -040069 if (!builder.emitAndInstallProcs()) {
halcanary96fcdcc2015-08-27 07:41:13 -070070 return nullptr;
joshualitt6c891102015-05-13 08:51:49 -070071 }
Brian Osmaned58e002019-09-06 14:42:43 -040072 return builder.finalize(precompiledProgram);
joshualitt47bb3822014-10-07 16:43:25 -070073}
74
joshualitt47bb3822014-10-07 16:43:25 -070075/////////////////////////////////////////////////////////////////////////////
76
egdaniel0e1853c2016-03-17 11:35:45 -070077GrGLProgramBuilder::GrGLProgramBuilder(GrGLGpu* gpu,
Robert Phillipsd0fe8752019-01-31 14:13:59 -050078 GrRenderTarget* renderTarget,
Stephen Whiteb1857852020-02-07 15:33:23 +000079 const GrProgramDesc& desc,
80 const GrProgramInfo& programInfo)
81 : INHERITED(renderTarget, desc, programInfo)
Brian Salomon802cb312018-06-08 18:05:20 -040082 , fGpu(gpu)
83 , fVaryingHandler(this)
84 , fUniformHandler(this)
Brian Salomon92be2f72018-06-19 14:33:47 -040085 , fVertexAttributeCnt(0)
86 , fInstanceAttributeCnt(0)
Brian Salomon802cb312018-06-08 18:05:20 -040087 , fVertexStride(0)
88 , fInstanceStride(0) {}
joshualitt30ba4362014-08-21 20:18:45 -070089
egdanielfa896322016-01-13 12:19:30 -080090const GrCaps* GrGLProgramBuilder::caps() const {
91 return fGpu->caps();
92}
93
Brian Osmanac9be9d2019-05-01 10:29:34 -040094bool GrGLProgramBuilder::compileAndAttachShaders(const SkSL::String& glsl,
egdaniel574a4c12015-11-02 06:22:44 -080095 GrGLuint programId,
96 GrGLenum type,
Ethan Nicholas941e7e22016-12-12 15:33:30 -050097 SkTDArray<GrGLuint>* shaderIds,
Brian Osman5e7fbfd2019-05-03 13:13:35 -040098 GrContextOptions::ShaderErrorHandler* errHandler) {
egdaniel574a4c12015-11-02 06:22:44 -080099 GrGLGpu* gpu = this->gpu();
100 GrGLuint shaderId = GrGLCompileAndAttachShader(gpu->glContext(),
101 programId,
102 type,
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400103 glsl,
Brian Osman8518f2e2019-05-01 14:13:41 -0400104 gpu->stats(),
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400105 errHandler);
egdaniel574a4c12015-11-02 06:22:44 -0800106 if (!shaderId) {
107 return false;
108 }
109
110 *shaderIds->append() = shaderId;
egdaniel574a4c12015-11-02 06:22:44 -0800111 return true;
112}
113
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400114void GrGLProgramBuilder::computeCountsAndStrides(GrGLuint programID,
115 const GrPrimitiveProcessor& primProc,
116 bool bindAttribLocations) {
117 fVertexAttributeCnt = primProc.numVertexAttributes();
118 fInstanceAttributeCnt = primProc.numInstanceAttributes();
119 fAttributes.reset(
120 new GrGLProgram::Attribute[fVertexAttributeCnt + fInstanceAttributeCnt]);
121 auto addAttr = [&](int i, const auto& a, size_t* stride) {
Brian Osman4a3f5c82018-09-18 16:16:38 -0400122 fAttributes[i].fCPUType = a.cpuType();
123 fAttributes[i].fGPUType = a.gpuType();
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400124 fAttributes[i].fOffset = *stride;
125 *stride += a.sizeAlign4();
126 fAttributes[i].fLocation = i;
127 if (bindAttribLocations) {
128 GL_CALL(BindAttribLocation(programID, i, a.name()));
129 }
130 };
131 fVertexStride = 0;
132 int i = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500133 for (const auto& attr : primProc.vertexAttributes()) {
134 addAttr(i++, attr, &fVertexStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400135 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500136 SkASSERT(fVertexStride == primProc.vertexStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400137 fInstanceStride = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500138 for (const auto& attr : primProc.instanceAttributes()) {
139 addAttr(i++, attr, &fInstanceStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400140 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500141 SkASSERT(fInstanceStride == primProc.instanceStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400142}
143
Ethan Nicholascd700e92018-08-24 16:43:57 -0400144void GrGLProgramBuilder::addInputVars(const SkSL::Program::Inputs& inputs) {
145 if (inputs.fRTWidth) {
146 this->addRTWidthUniform(SKSL_RTWIDTH_NAME);
147 }
148 if (inputs.fRTHeight) {
149 this->addRTHeightUniform(SKSL_RTHEIGHT_NAME);
150 }
151}
152
Brian Osmana085a412019-04-25 09:44:43 -0400153static constexpr SkFourByteTag kSKSL_Tag = SkSetFourByteTag('S', 'K', 'S', 'L');
154static constexpr SkFourByteTag kGLSL_Tag = SkSetFourByteTag('G', 'L', 'S', 'L');
Brian Osmana66081d2019-09-03 14:59:26 -0400155static constexpr SkFourByteTag kGLPB_Tag = SkSetFourByteTag('G', 'L', 'P', 'B');
Brian Osmana085a412019-04-25 09:44:43 -0400156
Ethan Nicholas8d058832019-01-07 10:49:58 -0500157void GrGLProgramBuilder::storeShaderInCache(const SkSL::Program::Inputs& inputs, GrGLuint programID,
Brian Osmaned58e002019-09-06 14:42:43 -0400158 const SkSL::String shaders[], bool isSkSL,
Brian Osman4524e842019-09-24 16:03:41 -0400159 SkSL::Program::Settings* settings) {
Robert Phillips9da87e02019-02-04 13:26:26 -0500160 if (!this->gpu()->getContext()->priv().getPersistentCache()) {
Ethan Nicholas8d058832019-01-07 10:49:58 -0500161 return;
162 }
Stephen Whiteb1857852020-02-07 15:33:23 +0000163 sk_sp<SkData> key = SkData::MakeWithoutCopy(this->desc().asKey(), this->desc().keyLength());
Ethan Nicholas8d058832019-01-07 10:49:58 -0500164 if (fGpu->glCaps().programBinarySupport()) {
165 // binary cache
166 GrGLsizei length = 0;
167 GL_CALL(GetProgramiv(programID, GL_PROGRAM_BINARY_LENGTH, &length));
168 if (length > 0) {
Brian Osman6b797fe2019-04-08 13:56:36 -0400169 SkWriter32 writer;
Brian Osmana66081d2019-09-03 14:59:26 -0400170 writer.write32(kGLPB_Tag);
171
Brian Osman6b797fe2019-04-08 13:56:36 -0400172 writer.writePad(&inputs, sizeof(inputs));
173 writer.write32(length);
174
175 void* binary = writer.reservePad(length);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500176 GrGLenum binaryFormat;
Brian Osman6b797fe2019-04-08 13:56:36 -0400177 GL_CALL(GetProgramBinary(programID, length, &length, &binaryFormat, binary));
178 writer.write32(binaryFormat);
179
180 auto data = writer.snapshotAsData();
181 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500182 }
183 } else {
Brian Osman4524e842019-09-24 16:03:41 -0400184 // source cache, plus metadata to allow for a complete precompile
185 GrPersistentCacheUtils::ShaderMetadata meta;
186 meta.fSettings = settings;
187 meta.fHasCustomColorOutput = fFS.hasCustomColorOutput();
188 meta.fHasSecondaryColorOutput = fFS.hasSecondaryOutput();
189 for (const auto& attr : this->primitiveProcessor().vertexAttributes()) {
190 meta.fAttributeNames.emplace_back(attr.name());
191 }
192 for (const auto& attr : this->primitiveProcessor().instanceAttributes()) {
193 meta.fAttributeNames.emplace_back(attr.name());
194 }
195
Brian Osmana085a412019-04-25 09:44:43 -0400196 auto data = GrPersistentCacheUtils::PackCachedShaders(isSkSL ? kSKSL_Tag : kGLSL_Tag,
Brian Osman4524e842019-09-24 16:03:41 -0400197 shaders, &inputs, 1, &meta);
Brian Osman6b797fe2019-04-08 13:56:36 -0400198 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500199 }
200}
201
Stephen Whiteb1857852020-02-07 15:33:23 +0000202sk_sp<GrGLProgram> GrGLProgramBuilder::finalize(const GrGLPrecompiledProgram* precompiledProgram) {
Brian Salomon5f394272019-07-02 14:07:49 -0400203 TRACE_EVENT0("skia.gpu", TRACE_FUNC);
Ryan Macnak38a10ad2017-07-10 10:36:34 -0700204
joshualitt47bb3822014-10-07 16:43:25 -0700205 // verify we can get a program id
206 GrGLuint programID;
Brian Osmaned58e002019-09-06 14:42:43 -0400207 if (precompiledProgram) {
208 programID = precompiledProgram->fProgramID;
209 } else {
210 GL_CALL_RET(programID, CreateProgram());
211 }
joshualitt47bb3822014-10-07 16:43:25 -0700212 if (0 == programID) {
halcanary96fcdcc2015-08-27 07:41:13 -0700213 return nullptr;
joshualitt30ba4362014-08-21 20:18:45 -0700214 }
215
Ethan Nicholas06d55fb2017-11-08 09:48:50 -0500216 if (this->gpu()->glCaps().programBinarySupport() &&
Brian Osman064729e2019-06-18 17:22:59 -0400217 this->gpu()->glCaps().programParameterSupport() &&
Brian Osmaned58e002019-09-06 14:42:43 -0400218 this->gpu()->getContext()->priv().getPersistentCache() &&
219 !precompiledProgram) {
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400220 GL_CALL(ProgramParameteri(programID, GR_GL_PROGRAM_BINARY_RETRIEVABLE_HINT, GR_GL_TRUE));
221 }
222
egdaniel9f1d4152016-02-10 09:50:38 -0800223 this->finalizeShaders();
224
joshualitt47bb3822014-10-07 16:43:25 -0700225 // compile shaders and bind attributes / uniforms
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400226 auto errorHandler = this->gpu()->getContext()->priv().getShaderErrorHandler();
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400227 const GrPrimitiveProcessor& primProc = this->primitiveProcessor();
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500228 SkSL::Program::Settings settings;
229 settings.fCaps = this->gpu()->glCaps().shaderCaps();
Robert Phillipsd0fe8752019-01-31 14:13:59 -0500230 settings.fFlipY = this->origin() != kTopLeft_GrSurfaceOrigin;
Robert Phillipsc1541ae2019-02-04 12:05:37 -0500231 settings.fSharpenTextures =
Robert Phillips9da87e02019-02-04 13:26:26 -0500232 this->gpu()->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Salomondc092132018-04-04 10:14:16 -0400233 settings.fFragColorIsInOut = this->fragColorIsInOut();
234
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500235 SkSL::Program::Inputs inputs;
joshualitt30ba4362014-08-21 20:18:45 -0700236 SkTDArray<GrGLuint> shadersToDelete;
Brian Salomond8575452020-02-25 12:13:29 -0500237
238 bool checkLinked = !fGpu->glCaps().skipErrorChecks();
239
Ethan Nicholas8d058832019-01-07 10:49:58 -0500240 bool cached = fCached.get() != nullptr;
Brian Osman2c60a382019-06-26 15:19:30 -0400241 bool usedProgramBinaries = false;
Brian Osman6b797fe2019-04-08 13:56:36 -0400242 SkSL::String glsl[kGrShaderTypeCount];
Brian Osmancbc33b82019-04-19 14:16:19 -0400243 SkSL::String* sksl[kGrShaderTypeCount] = {
244 &fVS.fCompilerString,
245 &fGS.fCompilerString,
246 &fFS.fCompilerString,
247 };
Brian Osmancbc33b82019-04-19 14:16:19 -0400248 SkSL::String cached_sksl[kGrShaderTypeCount];
Brian Osmaned58e002019-09-06 14:42:43 -0400249 if (precompiledProgram) {
250 // This is very similar to when we get program binaries. We even set that flag, as it's
251 // used to prevent other compile work later, and to force re-querying uniform locations.
252 this->addInputVars(precompiledProgram->fInputs);
Brian Osman4524e842019-09-24 16:03:41 -0400253 this->computeCountsAndStrides(programID, primProc, false);
Brian Osmaned58e002019-09-06 14:42:43 -0400254 usedProgramBinaries = true;
255 } else if (cached) {
Stan Iliev43324e72020-01-13 16:17:48 -0500256 ATRACE_ANDROID_FRAMEWORK_ALWAYS("cache_hit");
Brian Osmana66081d2019-09-03 14:59:26 -0400257 SkReader32 reader(fCached->data(), fCached->size());
Brian Osman1facd5e2020-03-16 16:21:24 -0400258 SkFourByteTag shaderType = GrPersistentCacheUtils::GetType(&reader);
Brian Osmana66081d2019-09-03 14:59:26 -0400259
260 switch (shaderType) {
261 case kGLPB_Tag: {
262 // Program binary cache hit. We may opt not to use this if we don't trust program
263 // binaries on this driver
264 if (!fGpu->glCaps().programBinarySupport()) {
265 cached = false;
266 break;
Ethan Nicholas8d058832019-01-07 10:49:58 -0500267 }
Brian Osmana66081d2019-09-03 14:59:26 -0400268 reader.read(&inputs, sizeof(inputs));
269 GrGLsizei length = reader.readInt();
270 const void* binary = reader.skip(length);
271 GrGLenum binaryFormat = reader.readU32();
272 GrGLClearErr(this->gpu()->glInterface());
273 GR_GL_CALL_NOERRCHECK(this->gpu()->glInterface(),
274 ProgramBinary(programID, binaryFormat,
275 const_cast<void*>(binary), length));
276 if (GR_GL_GET_ERROR(this->gpu()->glInterface()) == GR_GL_NO_ERROR) {
277 if (checkLinked) {
278 cached = this->checkLinkStatus(programID, errorHandler, nullptr, nullptr);
279 }
280 if (cached) {
281 this->addInputVars(inputs);
282 this->computeCountsAndStrides(programID, primProc, false);
283 }
284 } else {
285 cached = false;
Ethan Nicholas8d058832019-01-07 10:49:58 -0500286 }
Brian Osmana66081d2019-09-03 14:59:26 -0400287 usedProgramBinaries = cached;
288 break;
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400289 }
Brian Osmana66081d2019-09-03 14:59:26 -0400290
291 case kGLSL_Tag:
292 // Source cache hit, we don't need to compile the SkSL->GLSL
293 GrPersistentCacheUtils::UnpackCachedShaders(&reader, glsl, &inputs, 1);
294 break;
295
296 case kSKSL_Tag:
297 // SkSL cache hit, this should only happen in tools overriding the generated SkSL
298 GrPersistentCacheUtils::UnpackCachedShaders(&reader, cached_sksl, &inputs, 1);
Brian Osmana085a412019-04-25 09:44:43 -0400299 for (int i = 0; i < kGrShaderTypeCount; ++i) {
300 sksl[i] = &cached_sksl[i];
301 }
Brian Osmana66081d2019-09-03 14:59:26 -0400302 break;
Ethan Nicholas98ad5b72018-03-13 09:53:02 -0400303 }
304 }
Brian Osmana66081d2019-09-03 14:59:26 -0400305 if (!usedProgramBinaries) {
Stan Iliev43324e72020-01-13 16:17:48 -0500306 ATRACE_ANDROID_FRAMEWORK_ALWAYS("cache_miss");
Brian Osmanf7924452019-09-24 10:44:37 -0400307 // Either a cache miss, or we got something other than binaries from the cache
308
309 /*
310 Fragment Shader
311 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400312 if (glsl[kFragment_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400313 // Don't have cached GLSL, need to compile SkSL->GLSL
Ethan Nicholas8d058832019-01-07 10:49:58 -0500314 if (fFS.fForceHighPrecision) {
315 settings.fForceHighPrecision = true;
316 }
317 std::unique_ptr<SkSL::Program> fs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400318 SkSL::Program::kFragment_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400319 *sksl[kFragment_GrShaderType],
Ethan Nicholas8d058832019-01-07 10:49:58 -0500320 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400321 &glsl[kFragment_GrShaderType],
322 errorHandler);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500323 if (!fs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400324 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500325 return nullptr;
326 }
327 inputs = fs->fInputs;
egdaniel8dcdedc2015-11-11 06:27:20 -0800328 }
Brian Osmanf7924452019-09-24 10:44:37 -0400329
330 this->addInputVars(inputs);
Brian Osmanac9be9d2019-05-01 10:29:34 -0400331 if (!this->compileAndAttachShaders(glsl[kFragment_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400332 GR_GL_FRAGMENT_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400333 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400334 return nullptr;
335 }
336
Brian Osmanf7924452019-09-24 10:44:37 -0400337 /*
338 Vertex Shader
339 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400340 if (glsl[kVertex_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400341 // Don't have cached GLSL, need to compile SkSL->GLSL
342 std::unique_ptr<SkSL::Program> vs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400343 SkSL::Program::kVertex_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400344 *sksl[kVertex_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400345 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400346 &glsl[kVertex_GrShaderType],
347 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400348 if (!vs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400349 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400350 return nullptr;
351 }
352 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400353 if (!this->compileAndAttachShaders(glsl[kVertex_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400354 GR_GL_VERTEX_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400355 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400356 return nullptr;
357 }
358
Brian Osmanf7924452019-09-24 10:44:37 -0400359 // This also binds vertex attribute locations. NVPR doesn't really use vertices,
360 // even though it requires a vertex shader in the program.
361 if (!primProc.isPathRendering()) {
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400362 this->computeCountsAndStrides(programID, primProc, true);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400363 }
364
Brian Osmanf7924452019-09-24 10:44:37 -0400365 /*
Chris Dalton5a2f9622019-12-27 14:56:38 -0700366 Tessellation Shaders
367 */
368 if (fProgramInfo.primProc().willUseTessellationShaders()) {
369 // Tessellation shaders are not currently supported by SkSL. So here, we temporarily
370 // generate GLSL strings directly using back door methods on GrPrimitiveProcessor, and
371 // pass those raw strings on to the driver.
372 SkString versionAndExtensionDecls;
373 versionAndExtensionDecls.appendf("%s\n", this->shaderCaps()->versionDeclString());
374 if (const char* extensionString = this->shaderCaps()->tessellationExtensionString()) {
375 versionAndExtensionDecls.appendf("#extension %s : require\n", extensionString);
376 }
377
378 SkString tessControlShader = primProc.getTessControlShaderGLSL(
379 versionAndExtensionDecls.c_str(), *this->shaderCaps());
380 if (!this->compileAndAttachShaders(tessControlShader.c_str(), programID,
381 GR_GL_TESS_CONTROL_SHADER, &shadersToDelete,
382 errorHandler)) {
383 cleanup_program(fGpu, programID, shadersToDelete);
384 return nullptr;
385 }
386
387 SkString tessEvaluationShader = primProc.getTessEvaluationShaderGLSL(
388 versionAndExtensionDecls.c_str(), *this->shaderCaps());
389 if (!this->compileAndAttachShaders(tessEvaluationShader.c_str(), programID,
390 GR_GL_TESS_EVALUATION_SHADER, &shadersToDelete,
391 errorHandler)) {
392 cleanup_program(fGpu, programID, shadersToDelete);
393 return nullptr;
394 }
395 }
396
397 /*
Brian Osmanf7924452019-09-24 10:44:37 -0400398 Geometry Shader
399 */
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400400 if (primProc.willUseGeoShader()) {
Brian Osman6b797fe2019-04-08 13:56:36 -0400401 if (glsl[kGeometry_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400402 // Don't have cached GLSL, need to compile SkSL->GLSL
403 std::unique_ptr<SkSL::Program> gs;
404 gs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400405 SkSL::Program::kGeometry_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400406 *sksl[kGeometry_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400407 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400408 &glsl[kGeometry_GrShaderType],
409 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400410 if (!gs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400411 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400412 return nullptr;
413 }
414 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400415 if (!this->compileAndAttachShaders(glsl[kGeometry_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400416 GR_GL_GEOMETRY_SHADER, &shadersToDelete,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400417 errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400418 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400419 return nullptr;
420 }
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400421 }
422 this->bindProgramResourceLocations(programID);
423
424 GL_CALL(LinkProgram(programID));
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500425 if (checkLinked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400426 if (!this->checkLinkStatus(programID, errorHandler, sksl, glsl)) {
Brian Osman2ab2ac02019-09-09 13:54:54 -0400427 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500428 return nullptr;
Brian Salomone334c592017-05-15 11:00:58 -0400429 }
Brian Salomone334c592017-05-15 11:00:58 -0400430 }
joshualittfe1233c2014-10-07 12:16:35 -0700431 }
Brian Osman2c60a382019-06-26 15:19:30 -0400432 this->resolveProgramResourceLocations(programID, usedProgramBinaries);
joshualittdb0d3ca2014-10-07 12:42:26 -0700433
Brian Osmaned58e002019-09-06 14:42:43 -0400434 cleanup_shaders(fGpu, shadersToDelete);
Brian Osmane4c88bb2019-06-27 16:15:11 -0400435
436 // With ANGLE, we can't cache path-rendering programs. We use ProgramPathFragmentInputGen,
437 // and ANGLE's deserialized program state doesn't restore enough state to handle that.
438 // The native NVIDIA drivers do, but this is such an edge case that it's easier to just
439 // black-list caching these programs in all cases. See: anglebug.com/3619
Chris Dalton5a2f9622019-12-27 14:56:38 -0700440 //
441 // We temporarily can't cache tessellation shaders while using back door GLSL.
442 //
Brian Osmaned58e002019-09-06 14:42:43 -0400443 // We also can't cache SkSL or GLSL if we were given a precompiled program, but there's not
444 // much point in doing so.
Chris Dalton5a2f9622019-12-27 14:56:38 -0700445 if (!cached && !primProc.isPathRendering() && !primProc.willUseTessellationShaders() &&
446 !precompiledProgram) {
Chris Dalton8dae7eb2019-12-27 22:20:55 -0700447 // FIXME: Remove the check for tessellation shaders in the above 'if' once the back door
448 // GLSL mechanism is removed.
449 (void)&GrPrimitiveProcessor::getTessControlShaderGLSL;
Brian Osmana085a412019-04-25 09:44:43 -0400450 bool isSkSL = false;
Brian Osmana66081d2019-09-03 14:59:26 -0400451 if (fGpu->getContext()->priv().options().fShaderCacheStrategy ==
452 GrContextOptions::ShaderCacheStrategy::kSkSL) {
Brian Osmancbc33b82019-04-19 14:16:19 -0400453 for (int i = 0; i < kGrShaderTypeCount; ++i) {
Brian Osmanac9be9d2019-05-01 10:29:34 -0400454 glsl[i] = GrShaderUtils::PrettyPrint(*sksl[i]);
Brian Osmancbc33b82019-04-19 14:16:19 -0400455 }
Brian Osmana085a412019-04-25 09:44:43 -0400456 isSkSL = true;
Brian Osmancbc33b82019-04-19 14:16:19 -0400457 }
Brian Osman4524e842019-09-24 16:03:41 -0400458 this->storeShaderInCache(inputs, programID, glsl, isSkSL, &settings);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400459 }
joshualitt47bb3822014-10-07 16:43:25 -0700460 return this->createProgram(programID);
461}
462
kkinnunen7aedda52015-06-29 23:01:28 -0700463void GrGLProgramBuilder::bindProgramResourceLocations(GrGLuint programID) {
egdaniel7ea439b2015-12-03 09:20:44 -0800464 fUniformHandler.bindUniformLocations(programID, fGpu->glCaps());
kkinnunen7aedda52015-06-29 23:01:28 -0700465
egdaniel8dcdedc2015-11-11 06:27:20 -0800466 const GrGLCaps& caps = this->gpu()->glCaps();
467 if (fFS.hasCustomColorOutput() && caps.bindFragDataLocationSupport()) {
468 GL_CALL(BindFragDataLocation(programID, 0,
egdaniel2d721d32015-11-11 13:06:05 -0800469 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800470 }
Brian Salomon1edc5b92016-11-29 13:43:46 -0500471 if (fFS.hasSecondaryOutput() && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
egdaniel8dcdedc2015-11-11 06:27:20 -0800472 GL_CALL(BindFragDataLocationIndexed(programID, 0, 1,
egdaniel2d721d32015-11-11 13:06:05 -0800473 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800474 }
joshualittd8dd47b2015-09-11 11:45:01 -0700475
476 // handle NVPR separable varyings
477 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
478 !fGpu->glPathRendering()->shouldBindFragmentInputs()) {
479 return;
480 }
egdaniel0eafe792015-11-20 14:01:22 -0800481 int count = fVaryingHandler.fPathProcVaryingInfos.count();
joshualittd8dd47b2015-09-11 11:45:01 -0700482 for (int i = 0; i < count; ++i) {
egdaniel0eafe792015-11-20 14:01:22 -0800483 GL_CALL(BindFragmentInputLocation(programID, i,
484 fVaryingHandler.fPathProcVaryingInfos[i].fVariable.c_str()));
485 fVaryingHandler.fPathProcVaryingInfos[i].fLocation = i;
joshualittd8dd47b2015-09-11 11:45:01 -0700486 }
joshualitt47bb3822014-10-07 16:43:25 -0700487}
488
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400489bool GrGLProgramBuilder::checkLinkStatus(GrGLuint programID,
490 GrContextOptions::ShaderErrorHandler* errorHandler,
491 SkSL::String* sksl[], const SkSL::String glsl[]) {
joshualitt47bb3822014-10-07 16:43:25 -0700492 GrGLint linked = GR_GL_INIT_ZERO;
493 GL_CALL(GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
494 if (!linked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400495 SkSL::String allShaders;
496 if (sksl) {
497 allShaders.appendf("// Vertex SKSL\n%s\n", sksl[kVertex_GrShaderType]->c_str());
498 if (!sksl[kGeometry_GrShaderType]->empty()) {
499 allShaders.appendf("// Geometry SKSL\n%s\n", sksl[kGeometry_GrShaderType]->c_str());
500 }
501 allShaders.appendf("// Fragment SKSL\n%s\n", sksl[kFragment_GrShaderType]->c_str());
502 }
503 if (glsl) {
504 allShaders.appendf("// Vertex GLSL\n%s\n", glsl[kVertex_GrShaderType].c_str());
505 if (!glsl[kGeometry_GrShaderType].empty()) {
506 allShaders.appendf("// Geometry GLSL\n%s\n", glsl[kGeometry_GrShaderType].c_str());
507 }
508 allShaders.appendf("// Fragment GLSL\n%s\n", glsl[kFragment_GrShaderType].c_str());
509 }
joshualitt47bb3822014-10-07 16:43:25 -0700510 GrGLint infoLen = GR_GL_INIT_ZERO;
511 GL_CALL(GetProgramiv(programID, GR_GL_INFO_LOG_LENGTH, &infoLen));
512 SkAutoMalloc log(sizeof(char)*(infoLen+1)); // outside if for debugger
513 if (infoLen > 0) {
514 // retrieve length even though we don't need it to workaround
515 // bug in chrome cmd buffer param validation.
516 GrGLsizei length = GR_GL_INIT_ZERO;
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400517 GL_CALL(GetProgramInfoLog(programID, infoLen+1, &length, (char*)log.get()));
joshualitt47bb3822014-10-07 16:43:25 -0700518 }
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400519 errorHandler->compileError(allShaders.c_str(), infoLen > 0 ? (const char*)log.get() : "");
joshualitt47bb3822014-10-07 16:43:25 -0700520 }
521 return SkToBool(linked);
522}
523
Brian Osman2c60a382019-06-26 15:19:30 -0400524void GrGLProgramBuilder::resolveProgramResourceLocations(GrGLuint programID, bool force) {
525 fUniformHandler.getUniformLocations(programID, fGpu->glCaps(), force);
joshualittd8dd47b2015-09-11 11:45:01 -0700526
527 // handle NVPR separable varyings
528 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
kkinnunen7bdb05d2016-01-25 00:47:23 -0800529 fGpu->glPathRendering()->shouldBindFragmentInputs()) {
joshualittd8dd47b2015-09-11 11:45:01 -0700530 return;
531 }
egdaniel0eafe792015-11-20 14:01:22 -0800532 int count = fVaryingHandler.fPathProcVaryingInfos.count();
joshualittd8dd47b2015-09-11 11:45:01 -0700533 for (int i = 0; i < count; ++i) {
534 GrGLint location;
egdaniel0eafe792015-11-20 14:01:22 -0800535 GL_CALL_RET(location, GetProgramResourceLocation(
536 programID,
537 GR_GL_FRAGMENT_INPUT,
538 fVaryingHandler.fPathProcVaryingInfos[i].fVariable.c_str()));
539 fVaryingHandler.fPathProcVaryingInfos[i].fLocation = location;
joshualittd8dd47b2015-09-11 11:45:01 -0700540 }
joshualitt30ba4362014-08-21 20:18:45 -0700541}
542
Stephen Whiteb1857852020-02-07 15:33:23 +0000543sk_sp<GrGLProgram> GrGLProgramBuilder::createProgram(GrGLuint programID) {
544 return sk_sp<GrGLProgram>(new GrGLProgram(fGpu,
545 fUniformHandles,
546 programID,
547 fUniformHandler.fUniforms,
548 fUniformHandler.fSamplers,
549 fVaryingHandler.fPathProcVaryingInfos,
550 std::move(fGeometryProcessor),
551 std::move(fXferProcessor),
552 std::move(fFragmentProcessors),
553 fFragmentProcessorCnt,
554 std::move(fAttributes),
555 fVertexAttributeCnt,
556 fInstanceAttributeCnt,
557 fVertexStride,
558 fInstanceStride));
joshualitt47bb3822014-10-07 16:43:25 -0700559}
Brian Osmaned58e002019-09-06 14:42:43 -0400560
561bool GrGLProgramBuilder::PrecompileProgram(GrGLPrecompiledProgram* precompiledProgram,
562 GrGLGpu* gpu,
563 const SkData& cachedData) {
564 SkReader32 reader(cachedData.data(), cachedData.size());
Brian Osman1facd5e2020-03-16 16:21:24 -0400565 SkFourByteTag shaderType = GrPersistentCacheUtils::GetType(&reader);
Brian Osmaned58e002019-09-06 14:42:43 -0400566 if (shaderType != kSKSL_Tag) {
567 // TODO: Support GLSL, and maybe even program binaries, too?
568 return false;
569 }
570
571 const GrGLInterface* gl = gpu->glInterface();
572 auto errorHandler = gpu->getContext()->priv().getShaderErrorHandler();
573 GrGLuint programID;
574 GR_GL_CALL_RET(gl, programID, CreateProgram());
575 if (0 == programID) {
576 return false;
577 }
578
579 SkTDArray<GrGLuint> shadersToDelete;
580
581 SkSL::Program::Settings settings;
Brian Osman4524e842019-09-24 16:03:41 -0400582 const GrGLCaps& caps = gpu->glCaps();
583 settings.fCaps = caps.shaderCaps();
Brian Osmaned58e002019-09-06 14:42:43 -0400584 settings.fSharpenTextures = gpu->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Osman4524e842019-09-24 16:03:41 -0400585 GrPersistentCacheUtils::ShaderMetadata meta;
586 meta.fSettings = &settings;
Brian Osmaned58e002019-09-06 14:42:43 -0400587
588 SkSL::String shaders[kGrShaderTypeCount];
589 SkSL::Program::Inputs inputs;
Brian Osman4524e842019-09-24 16:03:41 -0400590 GrPersistentCacheUtils::UnpackCachedShaders(&reader, shaders, &inputs, 1, &meta);
Brian Osmaned58e002019-09-06 14:42:43 -0400591
592 auto compileShader = [&](SkSL::Program::Kind kind, const SkSL::String& sksl, GrGLenum type) {
593 SkSL::String glsl;
594 auto program = GrSkSLtoGLSL(gpu->glContext(), kind, sksl, settings, &glsl, errorHandler);
595 if (!program) {
596 return false;
597 }
598
599 if (GrGLuint shaderID = GrGLCompileAndAttachShader(gpu->glContext(), programID, type, glsl,
600 gpu->stats(), errorHandler)) {
601 shadersToDelete.push_back(shaderID);
602 return true;
603 } else {
604 return false;
605 }
606 };
607
608 if (!compileShader(SkSL::Program::kFragment_Kind,
609 shaders[kFragment_GrShaderType],
610 GR_GL_FRAGMENT_SHADER) ||
611 !compileShader(SkSL::Program::kVertex_Kind,
612 shaders[kVertex_GrShaderType],
613 GR_GL_VERTEX_SHADER) ||
614 (!shaders[kGeometry_GrShaderType].empty() &&
615 !compileShader(SkSL::Program::kGeometry_Kind,
616 shaders[kGeometry_GrShaderType],
617 GR_GL_GEOMETRY_SHADER))) {
618 cleanup_program(gpu, programID, shadersToDelete);
619 return false;
620 }
621
Brian Osman4524e842019-09-24 16:03:41 -0400622 for (int i = 0; i < meta.fAttributeNames.count(); ++i) {
623 GR_GL_CALL(gpu->glInterface(), BindAttribLocation(programID, i,
624 meta.fAttributeNames[i].c_str()));
625 }
626
627 if (meta.fHasCustomColorOutput && caps.bindFragDataLocationSupport()) {
628 GR_GL_CALL(gpu->glInterface(), BindFragDataLocation(programID, 0,
629 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
630 }
631 if (meta.fHasSecondaryColorOutput && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
632 GR_GL_CALL(gpu->glInterface(), BindFragDataLocationIndexed(programID, 0, 1,
633 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
634 }
635
Brian Osmaned58e002019-09-06 14:42:43 -0400636 GR_GL_CALL(gpu->glInterface(), LinkProgram(programID));
637 GrGLint linked = GR_GL_INIT_ZERO;
638 GR_GL_CALL(gpu->glInterface(), GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
639 if (!linked) {
640 cleanup_program(gpu, programID, shadersToDelete);
641 return false;
642 }
643
644 cleanup_shaders(gpu, shadersToDelete);
645
646 precompiledProgram->fProgramID = programID;
647 precompiledProgram->fInputs = inputs;
648 return true;
649}