blob: 07ea39c65cf03245bf6a96d204d65876e89f8115 [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
Robert Phillips65a77752019-10-02 15:22:24 -040048GrGLProgram* GrGLProgramBuilder::CreateProgram(GrRenderTarget* renderTarget,
Robert Phillips901aff02019-10-08 12:32:56 -040049 const GrProgramInfo& programInfo,
Ethan Nicholas38657112017-02-09 17:01:22 -050050 GrProgramDesc* desc,
Brian Osmaned58e002019-09-06 14:42:43 -040051 GrGLGpu* gpu,
52 const GrGLPrecompiledProgram* precompiledProgram) {
Robert Phillips901aff02019-10-08 12:32:56 -040053 SkASSERT(!programInfo.pipeline().isBad());
Robert Phillipsa91e0b72017-05-01 13:12:20 -040054
Derek Sollenberger488f0d62017-03-03 15:48:33 -050055 ATRACE_ANDROID_FRAMEWORK("Shader Compile");
bsalomon3318ee72015-03-16 11:56:29 -070056 GrAutoLocaleSetter als("C");
57
joshualitt47bb3822014-10-07 16:43:25 -070058 // create a builder. This will be handed off to effects so they can use it to add
59 // uniforms, varyings, textures, etc
Robert Phillips901aff02019-10-08 12:32:56 -040060 GrGLProgramBuilder builder(gpu, renderTarget, programInfo, desc);
joshualitt47bb3822014-10-07 16:43:25 -070061
Robert Phillips9da87e02019-02-04 13:26:26 -050062 auto persistentCache = gpu->getContext()->priv().getPersistentCache();
Brian Osmaned58e002019-09-06 14:42:43 -040063 if (persistentCache && !precompiledProgram) {
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -040064 sk_sp<SkData> key = SkData::MakeWithoutCopy(desc->asKey(), desc->keyLength());
Robert Phillips0c4b7b12018-03-06 08:20:37 -050065 builder.fCached = persistentCache->load(*key);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -040066 // the eventual end goal is to completely skip emitAndInstallProcs on a cache hit, but it's
67 // doing necessary setup in addition to generating the SkSL code. Currently we are only able
68 // to skip the SkSL->GLSL step on a cache hit.
69 }
Ethan Nicholas2983f402017-05-08 09:36:08 -040070 if (!builder.emitAndInstallProcs()) {
halcanary96fcdcc2015-08-27 07:41:13 -070071 return nullptr;
joshualitt6c891102015-05-13 08:51:49 -070072 }
Brian Osmaned58e002019-09-06 14:42:43 -040073 return builder.finalize(precompiledProgram);
joshualitt47bb3822014-10-07 16:43:25 -070074}
75
joshualitt47bb3822014-10-07 16:43:25 -070076/////////////////////////////////////////////////////////////////////////////
77
egdaniel0e1853c2016-03-17 11:35:45 -070078GrGLProgramBuilder::GrGLProgramBuilder(GrGLGpu* gpu,
Robert Phillipsd0fe8752019-01-31 14:13:59 -050079 GrRenderTarget* renderTarget,
Robert Phillips901aff02019-10-08 12:32:56 -040080 const GrProgramInfo& programInfo,
Ethan Nicholas38657112017-02-09 17:01:22 -050081 GrProgramDesc* desc)
Robert Phillips901aff02019-10-08 12:32:56 -040082 : INHERITED(renderTarget, programInfo, desc)
Brian Salomon802cb312018-06-08 18:05:20 -040083 , fGpu(gpu)
84 , fVaryingHandler(this)
85 , fUniformHandler(this)
Brian Salomon92be2f72018-06-19 14:33:47 -040086 , fVertexAttributeCnt(0)
87 , fInstanceAttributeCnt(0)
Brian Salomon802cb312018-06-08 18:05:20 -040088 , fVertexStride(0)
89 , fInstanceStride(0) {}
joshualitt30ba4362014-08-21 20:18:45 -070090
egdanielfa896322016-01-13 12:19:30 -080091const GrCaps* GrGLProgramBuilder::caps() const {
92 return fGpu->caps();
93}
94
Brian Osmanac9be9d2019-05-01 10:29:34 -040095bool GrGLProgramBuilder::compileAndAttachShaders(const SkSL::String& glsl,
egdaniel574a4c12015-11-02 06:22:44 -080096 GrGLuint programId,
97 GrGLenum type,
Ethan Nicholas941e7e22016-12-12 15:33:30 -050098 SkTDArray<GrGLuint>* shaderIds,
Brian Osman5e7fbfd2019-05-03 13:13:35 -040099 GrContextOptions::ShaderErrorHandler* errHandler) {
egdaniel574a4c12015-11-02 06:22:44 -0800100 GrGLGpu* gpu = this->gpu();
101 GrGLuint shaderId = GrGLCompileAndAttachShader(gpu->glContext(),
102 programId,
103 type,
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400104 glsl,
Brian Osman8518f2e2019-05-01 14:13:41 -0400105 gpu->stats(),
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400106 errHandler);
egdaniel574a4c12015-11-02 06:22:44 -0800107 if (!shaderId) {
108 return false;
109 }
110
111 *shaderIds->append() = shaderId;
egdaniel574a4c12015-11-02 06:22:44 -0800112 return true;
113}
114
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400115void GrGLProgramBuilder::computeCountsAndStrides(GrGLuint programID,
116 const GrPrimitiveProcessor& primProc,
117 bool bindAttribLocations) {
118 fVertexAttributeCnt = primProc.numVertexAttributes();
119 fInstanceAttributeCnt = primProc.numInstanceAttributes();
120 fAttributes.reset(
121 new GrGLProgram::Attribute[fVertexAttributeCnt + fInstanceAttributeCnt]);
122 auto addAttr = [&](int i, const auto& a, size_t* stride) {
Brian Osman4a3f5c82018-09-18 16:16:38 -0400123 fAttributes[i].fCPUType = a.cpuType();
124 fAttributes[i].fGPUType = a.gpuType();
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400125 fAttributes[i].fOffset = *stride;
126 *stride += a.sizeAlign4();
127 fAttributes[i].fLocation = i;
128 if (bindAttribLocations) {
129 GL_CALL(BindAttribLocation(programID, i, a.name()));
130 }
131 };
132 fVertexStride = 0;
133 int i = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500134 for (const auto& attr : primProc.vertexAttributes()) {
135 addAttr(i++, attr, &fVertexStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400136 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500137 SkASSERT(fVertexStride == primProc.vertexStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400138 fInstanceStride = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500139 for (const auto& attr : primProc.instanceAttributes()) {
140 addAttr(i++, attr, &fInstanceStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400141 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500142 SkASSERT(fInstanceStride == primProc.instanceStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400143}
144
Ethan Nicholascd700e92018-08-24 16:43:57 -0400145void GrGLProgramBuilder::addInputVars(const SkSL::Program::Inputs& inputs) {
146 if (inputs.fRTWidth) {
147 this->addRTWidthUniform(SKSL_RTWIDTH_NAME);
148 }
149 if (inputs.fRTHeight) {
150 this->addRTHeightUniform(SKSL_RTHEIGHT_NAME);
151 }
152}
153
Brian Osmana085a412019-04-25 09:44:43 -0400154static constexpr SkFourByteTag kSKSL_Tag = SkSetFourByteTag('S', 'K', 'S', 'L');
155static constexpr SkFourByteTag kGLSL_Tag = SkSetFourByteTag('G', 'L', 'S', 'L');
Brian Osmana66081d2019-09-03 14:59:26 -0400156static constexpr SkFourByteTag kGLPB_Tag = SkSetFourByteTag('G', 'L', 'P', 'B');
Brian Osmana085a412019-04-25 09:44:43 -0400157
Ethan Nicholas8d058832019-01-07 10:49:58 -0500158void GrGLProgramBuilder::storeShaderInCache(const SkSL::Program::Inputs& inputs, GrGLuint programID,
Brian Osmaned58e002019-09-06 14:42:43 -0400159 const SkSL::String shaders[], bool isSkSL,
Brian Osman4524e842019-09-24 16:03:41 -0400160 SkSL::Program::Settings* settings) {
Robert Phillips9da87e02019-02-04 13:26:26 -0500161 if (!this->gpu()->getContext()->priv().getPersistentCache()) {
Ethan Nicholas8d058832019-01-07 10:49:58 -0500162 return;
163 }
Robert Phillips901aff02019-10-08 12:32:56 -0400164 sk_sp<SkData> key = SkData::MakeWithoutCopy(this->desc()->asKey(), this->desc()->keyLength());
Ethan Nicholas8d058832019-01-07 10:49:58 -0500165 if (fGpu->glCaps().programBinarySupport()) {
166 // binary cache
167 GrGLsizei length = 0;
168 GL_CALL(GetProgramiv(programID, GL_PROGRAM_BINARY_LENGTH, &length));
169 if (length > 0) {
Brian Osman6b797fe2019-04-08 13:56:36 -0400170 SkWriter32 writer;
Brian Osmana66081d2019-09-03 14:59:26 -0400171 writer.write32(kGLPB_Tag);
172
Brian Osman6b797fe2019-04-08 13:56:36 -0400173 writer.writePad(&inputs, sizeof(inputs));
174 writer.write32(length);
175
176 void* binary = writer.reservePad(length);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500177 GrGLenum binaryFormat;
Brian Osman6b797fe2019-04-08 13:56:36 -0400178 GL_CALL(GetProgramBinary(programID, length, &length, &binaryFormat, binary));
179 writer.write32(binaryFormat);
180
181 auto data = writer.snapshotAsData();
182 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500183 }
184 } else {
Brian Osman4524e842019-09-24 16:03:41 -0400185 // source cache, plus metadata to allow for a complete precompile
186 GrPersistentCacheUtils::ShaderMetadata meta;
187 meta.fSettings = settings;
188 meta.fHasCustomColorOutput = fFS.hasCustomColorOutput();
189 meta.fHasSecondaryColorOutput = fFS.hasSecondaryOutput();
190 for (const auto& attr : this->primitiveProcessor().vertexAttributes()) {
191 meta.fAttributeNames.emplace_back(attr.name());
192 }
193 for (const auto& attr : this->primitiveProcessor().instanceAttributes()) {
194 meta.fAttributeNames.emplace_back(attr.name());
195 }
196
Brian Osmana085a412019-04-25 09:44:43 -0400197 auto data = GrPersistentCacheUtils::PackCachedShaders(isSkSL ? kSKSL_Tag : kGLSL_Tag,
Brian Osman4524e842019-09-24 16:03:41 -0400198 shaders, &inputs, 1, &meta);
Brian Osman6b797fe2019-04-08 13:56:36 -0400199 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500200 }
201}
202
Brian Osmaned58e002019-09-06 14:42:43 -0400203GrGLProgram* GrGLProgramBuilder::finalize(const GrGLPrecompiledProgram* precompiledProgram) {
Brian Salomon5f394272019-07-02 14:07:49 -0400204 TRACE_EVENT0("skia.gpu", TRACE_FUNC);
Ryan Macnak38a10ad2017-07-10 10:36:34 -0700205
joshualitt47bb3822014-10-07 16:43:25 -0700206 // verify we can get a program id
207 GrGLuint programID;
Brian Osmaned58e002019-09-06 14:42:43 -0400208 if (precompiledProgram) {
209 programID = precompiledProgram->fProgramID;
210 } else {
211 GL_CALL_RET(programID, CreateProgram());
212 }
joshualitt47bb3822014-10-07 16:43:25 -0700213 if (0 == programID) {
halcanary96fcdcc2015-08-27 07:41:13 -0700214 return nullptr;
joshualitt30ba4362014-08-21 20:18:45 -0700215 }
216
Ethan Nicholas06d55fb2017-11-08 09:48:50 -0500217 if (this->gpu()->glCaps().programBinarySupport() &&
Brian Osman064729e2019-06-18 17:22:59 -0400218 this->gpu()->glCaps().programParameterSupport() &&
Brian Osmaned58e002019-09-06 14:42:43 -0400219 this->gpu()->getContext()->priv().getPersistentCache() &&
220 !precompiledProgram) {
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400221 GL_CALL(ProgramParameteri(programID, GR_GL_PROGRAM_BINARY_RETRIEVABLE_HINT, GR_GL_TRUE));
222 }
223
egdaniel9f1d4152016-02-10 09:50:38 -0800224 this->finalizeShaders();
225
joshualitt47bb3822014-10-07 16:43:25 -0700226 // compile shaders and bind attributes / uniforms
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400227 auto errorHandler = this->gpu()->getContext()->priv().getShaderErrorHandler();
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400228 const GrPrimitiveProcessor& primProc = this->primitiveProcessor();
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500229 SkSL::Program::Settings settings;
230 settings.fCaps = this->gpu()->glCaps().shaderCaps();
Robert Phillipsd0fe8752019-01-31 14:13:59 -0500231 settings.fFlipY = this->origin() != kTopLeft_GrSurfaceOrigin;
Robert Phillipsc1541ae2019-02-04 12:05:37 -0500232 settings.fSharpenTextures =
Robert Phillips9da87e02019-02-04 13:26:26 -0500233 this->gpu()->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Salomondc092132018-04-04 10:14:16 -0400234 settings.fFragColorIsInOut = this->fragColorIsInOut();
235
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500236 SkSL::Program::Inputs inputs;
joshualitt30ba4362014-08-21 20:18:45 -0700237 SkTDArray<GrGLuint> shadersToDelete;
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500238 // Calling GetProgramiv is expensive in Chromium. Assume success in release builds.
239 bool checkLinked = kChromium_GrGLDriver != fGpu->ctxInfo().driver();
240#ifdef SK_DEBUG
241 checkLinked = true;
242#endif
Ethan Nicholas8d058832019-01-07 10:49:58 -0500243 bool cached = fCached.get() != nullptr;
Brian Osman2c60a382019-06-26 15:19:30 -0400244 bool usedProgramBinaries = false;
Brian Osman6b797fe2019-04-08 13:56:36 -0400245 SkSL::String glsl[kGrShaderTypeCount];
Brian Osmancbc33b82019-04-19 14:16:19 -0400246 SkSL::String* sksl[kGrShaderTypeCount] = {
247 &fVS.fCompilerString,
248 &fGS.fCompilerString,
249 &fFS.fCompilerString,
250 };
Brian Osmancbc33b82019-04-19 14:16:19 -0400251 SkSL::String cached_sksl[kGrShaderTypeCount];
Brian Osmaned58e002019-09-06 14:42:43 -0400252 if (precompiledProgram) {
253 // This is very similar to when we get program binaries. We even set that flag, as it's
254 // used to prevent other compile work later, and to force re-querying uniform locations.
255 this->addInputVars(precompiledProgram->fInputs);
Brian Osman4524e842019-09-24 16:03:41 -0400256 this->computeCountsAndStrides(programID, primProc, false);
Brian Osmaned58e002019-09-06 14:42:43 -0400257 usedProgramBinaries = true;
258 } else if (cached) {
Brian Osmana66081d2019-09-03 14:59:26 -0400259 SkReader32 reader(fCached->data(), fCached->size());
260 SkFourByteTag shaderType = reader.readU32();
261
262 switch (shaderType) {
263 case kGLPB_Tag: {
264 // Program binary cache hit. We may opt not to use this if we don't trust program
265 // binaries on this driver
266 if (!fGpu->glCaps().programBinarySupport()) {
267 cached = false;
268 break;
Ethan Nicholas8d058832019-01-07 10:49:58 -0500269 }
Brian Osmana66081d2019-09-03 14:59:26 -0400270 reader.read(&inputs, sizeof(inputs));
271 GrGLsizei length = reader.readInt();
272 const void* binary = reader.skip(length);
273 GrGLenum binaryFormat = reader.readU32();
274 GrGLClearErr(this->gpu()->glInterface());
275 GR_GL_CALL_NOERRCHECK(this->gpu()->glInterface(),
276 ProgramBinary(programID, binaryFormat,
277 const_cast<void*>(binary), length));
278 if (GR_GL_GET_ERROR(this->gpu()->glInterface()) == GR_GL_NO_ERROR) {
279 if (checkLinked) {
280 cached = this->checkLinkStatus(programID, errorHandler, nullptr, nullptr);
281 }
282 if (cached) {
283 this->addInputVars(inputs);
284 this->computeCountsAndStrides(programID, primProc, false);
285 }
286 } else {
287 cached = false;
Ethan Nicholas8d058832019-01-07 10:49:58 -0500288 }
Brian Osmana66081d2019-09-03 14:59:26 -0400289 usedProgramBinaries = cached;
290 break;
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400291 }
Brian Osmana66081d2019-09-03 14:59:26 -0400292
293 case kGLSL_Tag:
294 // Source cache hit, we don't need to compile the SkSL->GLSL
295 GrPersistentCacheUtils::UnpackCachedShaders(&reader, glsl, &inputs, 1);
296 break;
297
298 case kSKSL_Tag:
299 // SkSL cache hit, this should only happen in tools overriding the generated SkSL
300 GrPersistentCacheUtils::UnpackCachedShaders(&reader, cached_sksl, &inputs, 1);
Brian Osmana085a412019-04-25 09:44:43 -0400301 for (int i = 0; i < kGrShaderTypeCount; ++i) {
302 sksl[i] = &cached_sksl[i];
303 }
Brian Osmana66081d2019-09-03 14:59:26 -0400304 break;
Ethan Nicholas98ad5b72018-03-13 09:53:02 -0400305 }
306 }
Brian Osmana66081d2019-09-03 14:59:26 -0400307 if (!usedProgramBinaries) {
Brian Osmanf7924452019-09-24 10:44:37 -0400308 // Either a cache miss, or we got something other than binaries from the cache
309
310 /*
311 Fragment Shader
312 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400313 if (glsl[kFragment_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400314 // Don't have cached GLSL, need to compile SkSL->GLSL
Ethan Nicholas8d058832019-01-07 10:49:58 -0500315 if (fFS.fForceHighPrecision) {
316 settings.fForceHighPrecision = true;
317 }
318 std::unique_ptr<SkSL::Program> fs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400319 SkSL::Program::kFragment_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400320 *sksl[kFragment_GrShaderType],
Ethan Nicholas8d058832019-01-07 10:49:58 -0500321 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400322 &glsl[kFragment_GrShaderType],
323 errorHandler);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500324 if (!fs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400325 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500326 return nullptr;
327 }
328 inputs = fs->fInputs;
egdaniel8dcdedc2015-11-11 06:27:20 -0800329 }
Brian Osmanf7924452019-09-24 10:44:37 -0400330
331 this->addInputVars(inputs);
Brian Osmanac9be9d2019-05-01 10:29:34 -0400332 if (!this->compileAndAttachShaders(glsl[kFragment_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400333 GR_GL_FRAGMENT_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400334 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400335 return nullptr;
336 }
337
Brian Osmanf7924452019-09-24 10:44:37 -0400338 /*
339 Vertex Shader
340 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400341 if (glsl[kVertex_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400342 // Don't have cached GLSL, need to compile SkSL->GLSL
343 std::unique_ptr<SkSL::Program> vs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400344 SkSL::Program::kVertex_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400345 *sksl[kVertex_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400346 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400347 &glsl[kVertex_GrShaderType],
348 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400349 if (!vs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400350 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400351 return nullptr;
352 }
353 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400354 if (!this->compileAndAttachShaders(glsl[kVertex_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400355 GR_GL_VERTEX_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400356 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400357 return nullptr;
358 }
359
Brian Osmanf7924452019-09-24 10:44:37 -0400360 // This also binds vertex attribute locations. NVPR doesn't really use vertices,
361 // even though it requires a vertex shader in the program.
362 if (!primProc.isPathRendering()) {
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400363 this->computeCountsAndStrides(programID, primProc, true);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400364 }
365
Brian Osmanf7924452019-09-24 10:44:37 -0400366 /*
367 Geometry Shader
368 */
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400369 if (primProc.willUseGeoShader()) {
Brian Osman6b797fe2019-04-08 13:56:36 -0400370 if (glsl[kGeometry_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400371 // Don't have cached GLSL, need to compile SkSL->GLSL
372 std::unique_ptr<SkSL::Program> gs;
373 gs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400374 SkSL::Program::kGeometry_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400375 *sksl[kGeometry_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400376 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400377 &glsl[kGeometry_GrShaderType],
378 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400379 if (!gs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400380 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400381 return nullptr;
382 }
383 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400384 if (!this->compileAndAttachShaders(glsl[kGeometry_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400385 GR_GL_GEOMETRY_SHADER, &shadersToDelete,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400386 errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400387 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400388 return nullptr;
389 }
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400390 }
391 this->bindProgramResourceLocations(programID);
392
393 GL_CALL(LinkProgram(programID));
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500394 if (checkLinked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400395 if (!this->checkLinkStatus(programID, errorHandler, sksl, glsl)) {
Brian Osman2ab2ac02019-09-09 13:54:54 -0400396 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500397 return nullptr;
Brian Salomone334c592017-05-15 11:00:58 -0400398 }
Brian Salomone334c592017-05-15 11:00:58 -0400399 }
joshualittfe1233c2014-10-07 12:16:35 -0700400 }
Brian Osman2c60a382019-06-26 15:19:30 -0400401 this->resolveProgramResourceLocations(programID, usedProgramBinaries);
joshualittdb0d3ca2014-10-07 12:42:26 -0700402
Brian Osmaned58e002019-09-06 14:42:43 -0400403 cleanup_shaders(fGpu, shadersToDelete);
Brian Osmane4c88bb2019-06-27 16:15:11 -0400404
405 // With ANGLE, we can't cache path-rendering programs. We use ProgramPathFragmentInputGen,
406 // and ANGLE's deserialized program state doesn't restore enough state to handle that.
407 // The native NVIDIA drivers do, but this is such an edge case that it's easier to just
408 // black-list caching these programs in all cases. See: anglebug.com/3619
Brian Osmaned58e002019-09-06 14:42:43 -0400409 // We also can't cache SkSL or GLSL if we were given a precompiled program, but there's not
410 // much point in doing so.
411 if (!cached && !primProc.isPathRendering() && !precompiledProgram) {
Brian Osmana085a412019-04-25 09:44:43 -0400412 bool isSkSL = false;
Brian Osmana66081d2019-09-03 14:59:26 -0400413 if (fGpu->getContext()->priv().options().fShaderCacheStrategy ==
414 GrContextOptions::ShaderCacheStrategy::kSkSL) {
Brian Osmancbc33b82019-04-19 14:16:19 -0400415 for (int i = 0; i < kGrShaderTypeCount; ++i) {
Brian Osmanac9be9d2019-05-01 10:29:34 -0400416 glsl[i] = GrShaderUtils::PrettyPrint(*sksl[i]);
Brian Osmancbc33b82019-04-19 14:16:19 -0400417 }
Brian Osmana085a412019-04-25 09:44:43 -0400418 isSkSL = true;
Brian Osmancbc33b82019-04-19 14:16:19 -0400419 }
Brian Osman4524e842019-09-24 16:03:41 -0400420 this->storeShaderInCache(inputs, programID, glsl, isSkSL, &settings);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400421 }
joshualitt47bb3822014-10-07 16:43:25 -0700422 return this->createProgram(programID);
423}
424
kkinnunen7aedda52015-06-29 23:01:28 -0700425void GrGLProgramBuilder::bindProgramResourceLocations(GrGLuint programID) {
egdaniel7ea439b2015-12-03 09:20:44 -0800426 fUniformHandler.bindUniformLocations(programID, fGpu->glCaps());
kkinnunen7aedda52015-06-29 23:01:28 -0700427
egdaniel8dcdedc2015-11-11 06:27:20 -0800428 const GrGLCaps& caps = this->gpu()->glCaps();
429 if (fFS.hasCustomColorOutput() && caps.bindFragDataLocationSupport()) {
430 GL_CALL(BindFragDataLocation(programID, 0,
egdaniel2d721d32015-11-11 13:06:05 -0800431 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800432 }
Brian Salomon1edc5b92016-11-29 13:43:46 -0500433 if (fFS.hasSecondaryOutput() && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
egdaniel8dcdedc2015-11-11 06:27:20 -0800434 GL_CALL(BindFragDataLocationIndexed(programID, 0, 1,
egdaniel2d721d32015-11-11 13:06:05 -0800435 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800436 }
joshualittd8dd47b2015-09-11 11:45:01 -0700437
438 // handle NVPR separable varyings
439 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
440 !fGpu->glPathRendering()->shouldBindFragmentInputs()) {
441 return;
442 }
egdaniel0eafe792015-11-20 14:01:22 -0800443 int count = fVaryingHandler.fPathProcVaryingInfos.count();
joshualittd8dd47b2015-09-11 11:45:01 -0700444 for (int i = 0; i < count; ++i) {
egdaniel0eafe792015-11-20 14:01:22 -0800445 GL_CALL(BindFragmentInputLocation(programID, i,
446 fVaryingHandler.fPathProcVaryingInfos[i].fVariable.c_str()));
447 fVaryingHandler.fPathProcVaryingInfos[i].fLocation = i;
joshualittd8dd47b2015-09-11 11:45:01 -0700448 }
joshualitt47bb3822014-10-07 16:43:25 -0700449}
450
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400451bool GrGLProgramBuilder::checkLinkStatus(GrGLuint programID,
452 GrContextOptions::ShaderErrorHandler* errorHandler,
453 SkSL::String* sksl[], const SkSL::String glsl[]) {
joshualitt47bb3822014-10-07 16:43:25 -0700454 GrGLint linked = GR_GL_INIT_ZERO;
455 GL_CALL(GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
456 if (!linked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400457 SkSL::String allShaders;
458 if (sksl) {
459 allShaders.appendf("// Vertex SKSL\n%s\n", sksl[kVertex_GrShaderType]->c_str());
460 if (!sksl[kGeometry_GrShaderType]->empty()) {
461 allShaders.appendf("// Geometry SKSL\n%s\n", sksl[kGeometry_GrShaderType]->c_str());
462 }
463 allShaders.appendf("// Fragment SKSL\n%s\n", sksl[kFragment_GrShaderType]->c_str());
464 }
465 if (glsl) {
466 allShaders.appendf("// Vertex GLSL\n%s\n", glsl[kVertex_GrShaderType].c_str());
467 if (!glsl[kGeometry_GrShaderType].empty()) {
468 allShaders.appendf("// Geometry GLSL\n%s\n", glsl[kGeometry_GrShaderType].c_str());
469 }
470 allShaders.appendf("// Fragment GLSL\n%s\n", glsl[kFragment_GrShaderType].c_str());
471 }
joshualitt47bb3822014-10-07 16:43:25 -0700472 GrGLint infoLen = GR_GL_INIT_ZERO;
473 GL_CALL(GetProgramiv(programID, GR_GL_INFO_LOG_LENGTH, &infoLen));
474 SkAutoMalloc log(sizeof(char)*(infoLen+1)); // outside if for debugger
475 if (infoLen > 0) {
476 // retrieve length even though we don't need it to workaround
477 // bug in chrome cmd buffer param validation.
478 GrGLsizei length = GR_GL_INIT_ZERO;
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400479 GL_CALL(GetProgramInfoLog(programID, infoLen+1, &length, (char*)log.get()));
joshualitt47bb3822014-10-07 16:43:25 -0700480 }
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400481 errorHandler->compileError(allShaders.c_str(), infoLen > 0 ? (const char*)log.get() : "");
joshualitt47bb3822014-10-07 16:43:25 -0700482 }
483 return SkToBool(linked);
484}
485
Brian Osman2c60a382019-06-26 15:19:30 -0400486void GrGLProgramBuilder::resolveProgramResourceLocations(GrGLuint programID, bool force) {
487 fUniformHandler.getUniformLocations(programID, fGpu->glCaps(), force);
joshualittd8dd47b2015-09-11 11:45:01 -0700488
489 // handle NVPR separable varyings
490 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
kkinnunen7bdb05d2016-01-25 00:47:23 -0800491 fGpu->glPathRendering()->shouldBindFragmentInputs()) {
joshualittd8dd47b2015-09-11 11:45:01 -0700492 return;
493 }
egdaniel0eafe792015-11-20 14:01:22 -0800494 int count = fVaryingHandler.fPathProcVaryingInfos.count();
joshualittd8dd47b2015-09-11 11:45:01 -0700495 for (int i = 0; i < count; ++i) {
496 GrGLint location;
egdaniel0eafe792015-11-20 14:01:22 -0800497 GL_CALL_RET(location, GetProgramResourceLocation(
498 programID,
499 GR_GL_FRAGMENT_INPUT,
500 fVaryingHandler.fPathProcVaryingInfos[i].fVariable.c_str()));
501 fVaryingHandler.fPathProcVaryingInfos[i].fLocation = location;
joshualittd8dd47b2015-09-11 11:45:01 -0700502 }
joshualitt30ba4362014-08-21 20:18:45 -0700503}
504
joshualitt47bb3822014-10-07 16:43:25 -0700505GrGLProgram* GrGLProgramBuilder::createProgram(GrGLuint programID) {
egdaniel7ea439b2015-12-03 09:20:44 -0800506 return new GrGLProgram(fGpu,
egdaniel7ea439b2015-12-03 09:20:44 -0800507 fUniformHandles,
508 programID,
509 fUniformHandler.fUniforms,
egdaniel09aa1fc2016-04-20 07:09:46 -0700510 fUniformHandler.fSamplers,
egdaniel0eafe792015-11-20 14:01:22 -0800511 fVaryingHandler.fPathProcVaryingInfos,
Robert Phillips369e8b72017-08-01 16:13:04 -0400512 std::move(fGeometryProcessor),
513 std::move(fXferProcessor),
Brian Salomon4d3f5172018-06-07 14:42:52 -0400514 std::move(fFragmentProcessors),
Brian Salomon802cb312018-06-08 18:05:20 -0400515 fFragmentProcessorCnt,
516 std::move(fAttributes),
Brian Salomon92be2f72018-06-19 14:33:47 -0400517 fVertexAttributeCnt,
518 fInstanceAttributeCnt,
Brian Salomon802cb312018-06-08 18:05:20 -0400519 fVertexStride,
520 fInstanceStride);
joshualitt47bb3822014-10-07 16:43:25 -0700521}
Brian Osmaned58e002019-09-06 14:42:43 -0400522
523bool GrGLProgramBuilder::PrecompileProgram(GrGLPrecompiledProgram* precompiledProgram,
524 GrGLGpu* gpu,
525 const SkData& cachedData) {
526 SkReader32 reader(cachedData.data(), cachedData.size());
527 SkFourByteTag shaderType = reader.readU32();
528 if (shaderType != kSKSL_Tag) {
529 // TODO: Support GLSL, and maybe even program binaries, too?
530 return false;
531 }
532
533 const GrGLInterface* gl = gpu->glInterface();
534 auto errorHandler = gpu->getContext()->priv().getShaderErrorHandler();
535 GrGLuint programID;
536 GR_GL_CALL_RET(gl, programID, CreateProgram());
537 if (0 == programID) {
538 return false;
539 }
540
541 SkTDArray<GrGLuint> shadersToDelete;
542
543 SkSL::Program::Settings settings;
Brian Osman4524e842019-09-24 16:03:41 -0400544 const GrGLCaps& caps = gpu->glCaps();
545 settings.fCaps = caps.shaderCaps();
Brian Osmaned58e002019-09-06 14:42:43 -0400546 settings.fSharpenTextures = gpu->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Osman4524e842019-09-24 16:03:41 -0400547 GrPersistentCacheUtils::ShaderMetadata meta;
548 meta.fSettings = &settings;
Brian Osmaned58e002019-09-06 14:42:43 -0400549
550 SkSL::String shaders[kGrShaderTypeCount];
551 SkSL::Program::Inputs inputs;
Brian Osman4524e842019-09-24 16:03:41 -0400552 GrPersistentCacheUtils::UnpackCachedShaders(&reader, shaders, &inputs, 1, &meta);
Brian Osmaned58e002019-09-06 14:42:43 -0400553
554 auto compileShader = [&](SkSL::Program::Kind kind, const SkSL::String& sksl, GrGLenum type) {
555 SkSL::String glsl;
556 auto program = GrSkSLtoGLSL(gpu->glContext(), kind, sksl, settings, &glsl, errorHandler);
557 if (!program) {
558 return false;
559 }
560
561 if (GrGLuint shaderID = GrGLCompileAndAttachShader(gpu->glContext(), programID, type, glsl,
562 gpu->stats(), errorHandler)) {
563 shadersToDelete.push_back(shaderID);
564 return true;
565 } else {
566 return false;
567 }
568 };
569
570 if (!compileShader(SkSL::Program::kFragment_Kind,
571 shaders[kFragment_GrShaderType],
572 GR_GL_FRAGMENT_SHADER) ||
573 !compileShader(SkSL::Program::kVertex_Kind,
574 shaders[kVertex_GrShaderType],
575 GR_GL_VERTEX_SHADER) ||
576 (!shaders[kGeometry_GrShaderType].empty() &&
577 !compileShader(SkSL::Program::kGeometry_Kind,
578 shaders[kGeometry_GrShaderType],
579 GR_GL_GEOMETRY_SHADER))) {
580 cleanup_program(gpu, programID, shadersToDelete);
581 return false;
582 }
583
Brian Osman4524e842019-09-24 16:03:41 -0400584 for (int i = 0; i < meta.fAttributeNames.count(); ++i) {
585 GR_GL_CALL(gpu->glInterface(), BindAttribLocation(programID, i,
586 meta.fAttributeNames[i].c_str()));
587 }
588
589 if (meta.fHasCustomColorOutput && caps.bindFragDataLocationSupport()) {
590 GR_GL_CALL(gpu->glInterface(), BindFragDataLocation(programID, 0,
591 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
592 }
593 if (meta.fHasSecondaryColorOutput && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
594 GR_GL_CALL(gpu->glInterface(), BindFragDataLocationIndexed(programID, 0, 1,
595 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
596 }
597
Brian Osmaned58e002019-09-06 14:42:43 -0400598 GR_GL_CALL(gpu->glInterface(), LinkProgram(programID));
599 GrGLint linked = GR_GL_INIT_ZERO;
600 GR_GL_CALL(gpu->glInterface(), GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
601 if (!linked) {
602 cleanup_program(gpu, programID, shadersToDelete);
603 return false;
604 }
605
606 cleanup_shaders(gpu, shadersToDelete);
607
608 precompiledProgram->fProgramID = programID;
609 precompiledProgram->fInputs = inputs;
610 return true;
611}