blob: c521c31182de7c7dfde67ecd6659570713698635 [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 Phillipsd0fe8752019-01-31 14:13:59 -050048GrGLProgram* GrGLProgramBuilder::CreateProgram(GrRenderTarget* renderTarget, GrSurfaceOrigin origin,
49 const GrPrimitiveProcessor& primProc,
Greg Daniel9a51a862018-11-30 10:18:14 -050050 const GrTextureProxy* const primProcProxies[],
Brian Salomonff168d92018-06-23 15:17:27 -040051 const GrPipeline& pipeline,
Ethan Nicholas38657112017-02-09 17:01:22 -050052 GrProgramDesc* desc,
Brian Osmaned58e002019-09-06 14:42:43 -040053 GrGLGpu* gpu,
54 const GrGLPrecompiledProgram* precompiledProgram) {
Brian Salomon7eae3e02018-08-07 14:02:38 +000055 SkASSERT(!pipeline.isBad());
Robert Phillipsa91e0b72017-05-01 13:12:20 -040056
Derek Sollenberger488f0d62017-03-03 15:48:33 -050057 ATRACE_ANDROID_FRAMEWORK("Shader Compile");
bsalomon3318ee72015-03-16 11:56:29 -070058 GrAutoLocaleSetter als("C");
59
joshualitt47bb3822014-10-07 16:43:25 -070060 // create a builder. This will be handed off to effects so they can use it to add
61 // uniforms, varyings, textures, etc
Robert Phillipsd0fe8752019-01-31 14:13:59 -050062 GrGLProgramBuilder builder(gpu, renderTarget, origin,
63 pipeline, primProc, primProcProxies, desc);
joshualitt47bb3822014-10-07 16:43:25 -070064
Robert Phillips9da87e02019-02-04 13:26:26 -050065 auto persistentCache = gpu->getContext()->priv().getPersistentCache();
Brian Osmaned58e002019-09-06 14:42:43 -040066 if (persistentCache && !precompiledProgram) {
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -040067 sk_sp<SkData> key = SkData::MakeWithoutCopy(desc->asKey(), desc->keyLength());
Robert Phillips0c4b7b12018-03-06 08:20:37 -050068 builder.fCached = persistentCache->load(*key);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -040069 // the eventual end goal is to completely skip emitAndInstallProcs on a cache hit, but it's
70 // doing necessary setup in addition to generating the SkSL code. Currently we are only able
71 // to skip the SkSL->GLSL step on a cache hit.
72 }
Ethan Nicholas2983f402017-05-08 09:36:08 -040073 if (!builder.emitAndInstallProcs()) {
halcanary96fcdcc2015-08-27 07:41:13 -070074 return nullptr;
joshualitt6c891102015-05-13 08:51:49 -070075 }
Brian Osmaned58e002019-09-06 14:42:43 -040076 return builder.finalize(precompiledProgram);
joshualitt47bb3822014-10-07 16:43:25 -070077}
78
joshualitt47bb3822014-10-07 16:43:25 -070079/////////////////////////////////////////////////////////////////////////////
80
egdaniel0e1853c2016-03-17 11:35:45 -070081GrGLProgramBuilder::GrGLProgramBuilder(GrGLGpu* gpu,
Robert Phillipsd0fe8752019-01-31 14:13:59 -050082 GrRenderTarget* renderTarget,
83 GrSurfaceOrigin origin,
egdaniel0e1853c2016-03-17 11:35:45 -070084 const GrPipeline& pipeline,
85 const GrPrimitiveProcessor& primProc,
Greg Daniel9a51a862018-11-30 10:18:14 -050086 const GrTextureProxy* const primProcProxies[],
Ethan Nicholas38657112017-02-09 17:01:22 -050087 GrProgramDesc* desc)
Robert Phillipsd0fe8752019-01-31 14:13:59 -050088 : INHERITED(renderTarget, origin, primProc, primProcProxies, pipeline, desc)
Brian Salomon802cb312018-06-08 18:05:20 -040089 , fGpu(gpu)
90 , fVaryingHandler(this)
91 , fUniformHandler(this)
Brian Salomon92be2f72018-06-19 14:33:47 -040092 , fVertexAttributeCnt(0)
93 , fInstanceAttributeCnt(0)
Brian Salomon802cb312018-06-08 18:05:20 -040094 , fVertexStride(0)
95 , fInstanceStride(0) {}
joshualitt30ba4362014-08-21 20:18:45 -070096
egdanielfa896322016-01-13 12:19:30 -080097const GrCaps* GrGLProgramBuilder::caps() const {
98 return fGpu->caps();
99}
100
Brian Osmanac9be9d2019-05-01 10:29:34 -0400101bool GrGLProgramBuilder::compileAndAttachShaders(const SkSL::String& glsl,
egdaniel574a4c12015-11-02 06:22:44 -0800102 GrGLuint programId,
103 GrGLenum type,
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500104 SkTDArray<GrGLuint>* shaderIds,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400105 GrContextOptions::ShaderErrorHandler* errHandler) {
egdaniel574a4c12015-11-02 06:22:44 -0800106 GrGLGpu* gpu = this->gpu();
107 GrGLuint shaderId = GrGLCompileAndAttachShader(gpu->glContext(),
108 programId,
109 type,
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400110 glsl,
Brian Osman8518f2e2019-05-01 14:13:41 -0400111 gpu->stats(),
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400112 errHandler);
egdaniel574a4c12015-11-02 06:22:44 -0800113 if (!shaderId) {
114 return false;
115 }
116
117 *shaderIds->append() = shaderId;
egdaniel574a4c12015-11-02 06:22:44 -0800118 return true;
119}
120
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400121void GrGLProgramBuilder::computeCountsAndStrides(GrGLuint programID,
122 const GrPrimitiveProcessor& primProc,
123 bool bindAttribLocations) {
124 fVertexAttributeCnt = primProc.numVertexAttributes();
125 fInstanceAttributeCnt = primProc.numInstanceAttributes();
126 fAttributes.reset(
127 new GrGLProgram::Attribute[fVertexAttributeCnt + fInstanceAttributeCnt]);
128 auto addAttr = [&](int i, const auto& a, size_t* stride) {
Brian Osman4a3f5c82018-09-18 16:16:38 -0400129 fAttributes[i].fCPUType = a.cpuType();
130 fAttributes[i].fGPUType = a.gpuType();
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400131 fAttributes[i].fOffset = *stride;
132 *stride += a.sizeAlign4();
133 fAttributes[i].fLocation = i;
134 if (bindAttribLocations) {
135 GL_CALL(BindAttribLocation(programID, i, a.name()));
136 }
137 };
138 fVertexStride = 0;
139 int i = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500140 for (const auto& attr : primProc.vertexAttributes()) {
141 addAttr(i++, attr, &fVertexStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400142 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500143 SkASSERT(fVertexStride == primProc.vertexStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400144 fInstanceStride = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500145 for (const auto& attr : primProc.instanceAttributes()) {
146 addAttr(i++, attr, &fInstanceStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400147 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500148 SkASSERT(fInstanceStride == primProc.instanceStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400149}
150
Ethan Nicholascd700e92018-08-24 16:43:57 -0400151void GrGLProgramBuilder::addInputVars(const SkSL::Program::Inputs& inputs) {
152 if (inputs.fRTWidth) {
153 this->addRTWidthUniform(SKSL_RTWIDTH_NAME);
154 }
155 if (inputs.fRTHeight) {
156 this->addRTHeightUniform(SKSL_RTHEIGHT_NAME);
157 }
158}
159
Brian Osmana085a412019-04-25 09:44:43 -0400160static constexpr SkFourByteTag kSKSL_Tag = SkSetFourByteTag('S', 'K', 'S', 'L');
161static constexpr SkFourByteTag kGLSL_Tag = SkSetFourByteTag('G', 'L', 'S', 'L');
Brian Osmana66081d2019-09-03 14:59:26 -0400162static constexpr SkFourByteTag kGLPB_Tag = SkSetFourByteTag('G', 'L', 'P', 'B');
Brian Osmana085a412019-04-25 09:44:43 -0400163
Ethan Nicholas8d058832019-01-07 10:49:58 -0500164void GrGLProgramBuilder::storeShaderInCache(const SkSL::Program::Inputs& inputs, GrGLuint programID,
Brian Osmaned58e002019-09-06 14:42:43 -0400165 const SkSL::String shaders[], bool isSkSL,
Brian Osman4524e842019-09-24 16:03:41 -0400166 SkSL::Program::Settings* settings) {
Robert Phillips9da87e02019-02-04 13:26:26 -0500167 if (!this->gpu()->getContext()->priv().getPersistentCache()) {
Ethan Nicholas8d058832019-01-07 10:49:58 -0500168 return;
169 }
170 sk_sp<SkData> key = SkData::MakeWithoutCopy(desc()->asKey(), desc()->keyLength());
171 if (fGpu->glCaps().programBinarySupport()) {
172 // binary cache
173 GrGLsizei length = 0;
174 GL_CALL(GetProgramiv(programID, GL_PROGRAM_BINARY_LENGTH, &length));
175 if (length > 0) {
Brian Osman6b797fe2019-04-08 13:56:36 -0400176 SkWriter32 writer;
Brian Osmana66081d2019-09-03 14:59:26 -0400177 writer.write32(kGLPB_Tag);
178
Brian Osman6b797fe2019-04-08 13:56:36 -0400179 writer.writePad(&inputs, sizeof(inputs));
180 writer.write32(length);
181
182 void* binary = writer.reservePad(length);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500183 GrGLenum binaryFormat;
Brian Osman6b797fe2019-04-08 13:56:36 -0400184 GL_CALL(GetProgramBinary(programID, length, &length, &binaryFormat, binary));
185 writer.write32(binaryFormat);
186
187 auto data = writer.snapshotAsData();
188 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500189 }
190 } else {
Brian Osman4524e842019-09-24 16:03:41 -0400191 // source cache, plus metadata to allow for a complete precompile
192 GrPersistentCacheUtils::ShaderMetadata meta;
193 meta.fSettings = settings;
194 meta.fHasCustomColorOutput = fFS.hasCustomColorOutput();
195 meta.fHasSecondaryColorOutput = fFS.hasSecondaryOutput();
196 for (const auto& attr : this->primitiveProcessor().vertexAttributes()) {
197 meta.fAttributeNames.emplace_back(attr.name());
198 }
199 for (const auto& attr : this->primitiveProcessor().instanceAttributes()) {
200 meta.fAttributeNames.emplace_back(attr.name());
201 }
202
Brian Osmana085a412019-04-25 09:44:43 -0400203 auto data = GrPersistentCacheUtils::PackCachedShaders(isSkSL ? kSKSL_Tag : kGLSL_Tag,
Brian Osman4524e842019-09-24 16:03:41 -0400204 shaders, &inputs, 1, &meta);
Brian Osman6b797fe2019-04-08 13:56:36 -0400205 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500206 }
207}
208
Brian Osmaned58e002019-09-06 14:42:43 -0400209GrGLProgram* GrGLProgramBuilder::finalize(const GrGLPrecompiledProgram* precompiledProgram) {
Brian Salomon5f394272019-07-02 14:07:49 -0400210 TRACE_EVENT0("skia.gpu", TRACE_FUNC);
Ryan Macnak38a10ad2017-07-10 10:36:34 -0700211
joshualitt47bb3822014-10-07 16:43:25 -0700212 // verify we can get a program id
213 GrGLuint programID;
Brian Osmaned58e002019-09-06 14:42:43 -0400214 if (precompiledProgram) {
215 programID = precompiledProgram->fProgramID;
216 } else {
217 GL_CALL_RET(programID, CreateProgram());
218 }
joshualitt47bb3822014-10-07 16:43:25 -0700219 if (0 == programID) {
halcanary96fcdcc2015-08-27 07:41:13 -0700220 return nullptr;
joshualitt30ba4362014-08-21 20:18:45 -0700221 }
222
Ethan Nicholas06d55fb2017-11-08 09:48:50 -0500223 if (this->gpu()->glCaps().programBinarySupport() &&
Brian Osman064729e2019-06-18 17:22:59 -0400224 this->gpu()->glCaps().programParameterSupport() &&
Brian Osmaned58e002019-09-06 14:42:43 -0400225 this->gpu()->getContext()->priv().getPersistentCache() &&
226 !precompiledProgram) {
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400227 GL_CALL(ProgramParameteri(programID, GR_GL_PROGRAM_BINARY_RETRIEVABLE_HINT, GR_GL_TRUE));
228 }
229
egdaniel9f1d4152016-02-10 09:50:38 -0800230 this->finalizeShaders();
231
joshualitt47bb3822014-10-07 16:43:25 -0700232 // compile shaders and bind attributes / uniforms
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400233 auto errorHandler = this->gpu()->getContext()->priv().getShaderErrorHandler();
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400234 const GrPrimitiveProcessor& primProc = this->primitiveProcessor();
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500235 SkSL::Program::Settings settings;
236 settings.fCaps = this->gpu()->glCaps().shaderCaps();
Robert Phillipsd0fe8752019-01-31 14:13:59 -0500237 settings.fFlipY = this->origin() != kTopLeft_GrSurfaceOrigin;
Robert Phillipsc1541ae2019-02-04 12:05:37 -0500238 settings.fSharpenTextures =
Robert Phillips9da87e02019-02-04 13:26:26 -0500239 this->gpu()->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Salomondc092132018-04-04 10:14:16 -0400240 settings.fFragColorIsInOut = this->fragColorIsInOut();
241
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500242 SkSL::Program::Inputs inputs;
joshualitt30ba4362014-08-21 20:18:45 -0700243 SkTDArray<GrGLuint> shadersToDelete;
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500244 // Calling GetProgramiv is expensive in Chromium. Assume success in release builds.
245 bool checkLinked = kChromium_GrGLDriver != fGpu->ctxInfo().driver();
246#ifdef SK_DEBUG
247 checkLinked = true;
248#endif
Ethan Nicholas8d058832019-01-07 10:49:58 -0500249 bool cached = fCached.get() != nullptr;
Brian Osman2c60a382019-06-26 15:19:30 -0400250 bool usedProgramBinaries = false;
Brian Osman6b797fe2019-04-08 13:56:36 -0400251 SkSL::String glsl[kGrShaderTypeCount];
Brian Osmancbc33b82019-04-19 14:16:19 -0400252 SkSL::String* sksl[kGrShaderTypeCount] = {
253 &fVS.fCompilerString,
254 &fGS.fCompilerString,
255 &fFS.fCompilerString,
256 };
Brian Osmancbc33b82019-04-19 14:16:19 -0400257 SkSL::String cached_sksl[kGrShaderTypeCount];
Brian Osmaned58e002019-09-06 14:42:43 -0400258 if (precompiledProgram) {
259 // This is very similar to when we get program binaries. We even set that flag, as it's
260 // used to prevent other compile work later, and to force re-querying uniform locations.
261 this->addInputVars(precompiledProgram->fInputs);
Brian Osman4524e842019-09-24 16:03:41 -0400262 this->computeCountsAndStrides(programID, primProc, false);
Brian Osmaned58e002019-09-06 14:42:43 -0400263 usedProgramBinaries = true;
264 } else if (cached) {
Brian Osmana66081d2019-09-03 14:59:26 -0400265 SkReader32 reader(fCached->data(), fCached->size());
266 SkFourByteTag shaderType = reader.readU32();
267
268 switch (shaderType) {
269 case kGLPB_Tag: {
270 // Program binary cache hit. We may opt not to use this if we don't trust program
271 // binaries on this driver
272 if (!fGpu->glCaps().programBinarySupport()) {
273 cached = false;
274 break;
Ethan Nicholas8d058832019-01-07 10:49:58 -0500275 }
Brian Osmana66081d2019-09-03 14:59:26 -0400276 reader.read(&inputs, sizeof(inputs));
277 GrGLsizei length = reader.readInt();
278 const void* binary = reader.skip(length);
279 GrGLenum binaryFormat = reader.readU32();
280 GrGLClearErr(this->gpu()->glInterface());
281 GR_GL_CALL_NOERRCHECK(this->gpu()->glInterface(),
282 ProgramBinary(programID, binaryFormat,
283 const_cast<void*>(binary), length));
284 if (GR_GL_GET_ERROR(this->gpu()->glInterface()) == GR_GL_NO_ERROR) {
285 if (checkLinked) {
286 cached = this->checkLinkStatus(programID, errorHandler, nullptr, nullptr);
287 }
288 if (cached) {
289 this->addInputVars(inputs);
290 this->computeCountsAndStrides(programID, primProc, false);
291 }
292 } else {
293 cached = false;
Ethan Nicholas8d058832019-01-07 10:49:58 -0500294 }
Brian Osmana66081d2019-09-03 14:59:26 -0400295 usedProgramBinaries = cached;
296 break;
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400297 }
Brian Osmana66081d2019-09-03 14:59:26 -0400298
299 case kGLSL_Tag:
300 // Source cache hit, we don't need to compile the SkSL->GLSL
301 GrPersistentCacheUtils::UnpackCachedShaders(&reader, glsl, &inputs, 1);
302 break;
303
304 case kSKSL_Tag:
305 // SkSL cache hit, this should only happen in tools overriding the generated SkSL
306 GrPersistentCacheUtils::UnpackCachedShaders(&reader, cached_sksl, &inputs, 1);
Brian Osmana085a412019-04-25 09:44:43 -0400307 for (int i = 0; i < kGrShaderTypeCount; ++i) {
308 sksl[i] = &cached_sksl[i];
309 }
Brian Osmana66081d2019-09-03 14:59:26 -0400310 break;
Ethan Nicholas98ad5b72018-03-13 09:53:02 -0400311 }
312 }
Brian Osmana66081d2019-09-03 14:59:26 -0400313 if (!usedProgramBinaries) {
Brian Osmanf7924452019-09-24 10:44:37 -0400314 // Either a cache miss, or we got something other than binaries from the cache
315
316 /*
317 Fragment Shader
318 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400319 if (glsl[kFragment_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400320 // Don't have cached GLSL, need to compile SkSL->GLSL
Ethan Nicholas8d058832019-01-07 10:49:58 -0500321 if (fFS.fForceHighPrecision) {
322 settings.fForceHighPrecision = true;
323 }
324 std::unique_ptr<SkSL::Program> fs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400325 SkSL::Program::kFragment_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400326 *sksl[kFragment_GrShaderType],
Ethan Nicholas8d058832019-01-07 10:49:58 -0500327 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400328 &glsl[kFragment_GrShaderType],
329 errorHandler);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500330 if (!fs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400331 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500332 return nullptr;
333 }
334 inputs = fs->fInputs;
egdaniel8dcdedc2015-11-11 06:27:20 -0800335 }
Brian Osmanf7924452019-09-24 10:44:37 -0400336
337 this->addInputVars(inputs);
Brian Osmanac9be9d2019-05-01 10:29:34 -0400338 if (!this->compileAndAttachShaders(glsl[kFragment_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400339 GR_GL_FRAGMENT_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400340 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400341 return nullptr;
342 }
343
Brian Osmanf7924452019-09-24 10:44:37 -0400344 /*
345 Vertex Shader
346 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400347 if (glsl[kVertex_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400348 // Don't have cached GLSL, need to compile SkSL->GLSL
349 std::unique_ptr<SkSL::Program> vs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400350 SkSL::Program::kVertex_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400351 *sksl[kVertex_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400352 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400353 &glsl[kVertex_GrShaderType],
354 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400355 if (!vs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400356 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400357 return nullptr;
358 }
359 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400360 if (!this->compileAndAttachShaders(glsl[kVertex_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400361 GR_GL_VERTEX_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400362 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400363 return nullptr;
364 }
365
Brian Osmanf7924452019-09-24 10:44:37 -0400366 // This also binds vertex attribute locations. NVPR doesn't really use vertices,
367 // even though it requires a vertex shader in the program.
368 if (!primProc.isPathRendering()) {
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400369 this->computeCountsAndStrides(programID, primProc, true);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400370 }
371
Brian Osmanf7924452019-09-24 10:44:37 -0400372 /*
373 Geometry Shader
374 */
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400375 if (primProc.willUseGeoShader()) {
Brian Osman6b797fe2019-04-08 13:56:36 -0400376 if (glsl[kGeometry_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400377 // Don't have cached GLSL, need to compile SkSL->GLSL
378 std::unique_ptr<SkSL::Program> gs;
379 gs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400380 SkSL::Program::kGeometry_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400381 *sksl[kGeometry_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400382 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400383 &glsl[kGeometry_GrShaderType],
384 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400385 if (!gs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400386 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400387 return nullptr;
388 }
389 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400390 if (!this->compileAndAttachShaders(glsl[kGeometry_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400391 GR_GL_GEOMETRY_SHADER, &shadersToDelete,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400392 errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400393 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400394 return nullptr;
395 }
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400396 }
397 this->bindProgramResourceLocations(programID);
398
399 GL_CALL(LinkProgram(programID));
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500400 if (checkLinked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400401 if (!this->checkLinkStatus(programID, errorHandler, sksl, glsl)) {
Brian Osman2ab2ac02019-09-09 13:54:54 -0400402 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500403 return nullptr;
Brian Salomone334c592017-05-15 11:00:58 -0400404 }
Brian Salomone334c592017-05-15 11:00:58 -0400405 }
joshualittfe1233c2014-10-07 12:16:35 -0700406 }
Brian Osman2c60a382019-06-26 15:19:30 -0400407 this->resolveProgramResourceLocations(programID, usedProgramBinaries);
joshualittdb0d3ca2014-10-07 12:42:26 -0700408
Brian Osmaned58e002019-09-06 14:42:43 -0400409 cleanup_shaders(fGpu, shadersToDelete);
Brian Osmane4c88bb2019-06-27 16:15:11 -0400410
411 // With ANGLE, we can't cache path-rendering programs. We use ProgramPathFragmentInputGen,
412 // and ANGLE's deserialized program state doesn't restore enough state to handle that.
413 // The native NVIDIA drivers do, but this is such an edge case that it's easier to just
414 // black-list caching these programs in all cases. See: anglebug.com/3619
Brian Osmaned58e002019-09-06 14:42:43 -0400415 // We also can't cache SkSL or GLSL if we were given a precompiled program, but there's not
416 // much point in doing so.
417 if (!cached && !primProc.isPathRendering() && !precompiledProgram) {
Brian Osmana085a412019-04-25 09:44:43 -0400418 bool isSkSL = false;
Brian Osmana66081d2019-09-03 14:59:26 -0400419 if (fGpu->getContext()->priv().options().fShaderCacheStrategy ==
420 GrContextOptions::ShaderCacheStrategy::kSkSL) {
Brian Osmancbc33b82019-04-19 14:16:19 -0400421 for (int i = 0; i < kGrShaderTypeCount; ++i) {
Brian Osmanac9be9d2019-05-01 10:29:34 -0400422 glsl[i] = GrShaderUtils::PrettyPrint(*sksl[i]);
Brian Osmancbc33b82019-04-19 14:16:19 -0400423 }
Brian Osmana085a412019-04-25 09:44:43 -0400424 isSkSL = true;
Brian Osmancbc33b82019-04-19 14:16:19 -0400425 }
Brian Osman4524e842019-09-24 16:03:41 -0400426 this->storeShaderInCache(inputs, programID, glsl, isSkSL, &settings);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400427 }
joshualitt47bb3822014-10-07 16:43:25 -0700428 return this->createProgram(programID);
429}
430
kkinnunen7aedda52015-06-29 23:01:28 -0700431void GrGLProgramBuilder::bindProgramResourceLocations(GrGLuint programID) {
egdaniel7ea439b2015-12-03 09:20:44 -0800432 fUniformHandler.bindUniformLocations(programID, fGpu->glCaps());
kkinnunen7aedda52015-06-29 23:01:28 -0700433
egdaniel8dcdedc2015-11-11 06:27:20 -0800434 const GrGLCaps& caps = this->gpu()->glCaps();
435 if (fFS.hasCustomColorOutput() && caps.bindFragDataLocationSupport()) {
436 GL_CALL(BindFragDataLocation(programID, 0,
egdaniel2d721d32015-11-11 13:06:05 -0800437 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800438 }
Brian Salomon1edc5b92016-11-29 13:43:46 -0500439 if (fFS.hasSecondaryOutput() && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
egdaniel8dcdedc2015-11-11 06:27:20 -0800440 GL_CALL(BindFragDataLocationIndexed(programID, 0, 1,
egdaniel2d721d32015-11-11 13:06:05 -0800441 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800442 }
joshualittd8dd47b2015-09-11 11:45:01 -0700443
444 // handle NVPR separable varyings
445 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
446 !fGpu->glPathRendering()->shouldBindFragmentInputs()) {
447 return;
448 }
egdaniel0eafe792015-11-20 14:01:22 -0800449 int count = fVaryingHandler.fPathProcVaryingInfos.count();
joshualittd8dd47b2015-09-11 11:45:01 -0700450 for (int i = 0; i < count; ++i) {
egdaniel0eafe792015-11-20 14:01:22 -0800451 GL_CALL(BindFragmentInputLocation(programID, i,
452 fVaryingHandler.fPathProcVaryingInfos[i].fVariable.c_str()));
453 fVaryingHandler.fPathProcVaryingInfos[i].fLocation = i;
joshualittd8dd47b2015-09-11 11:45:01 -0700454 }
joshualitt47bb3822014-10-07 16:43:25 -0700455}
456
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400457bool GrGLProgramBuilder::checkLinkStatus(GrGLuint programID,
458 GrContextOptions::ShaderErrorHandler* errorHandler,
459 SkSL::String* sksl[], const SkSL::String glsl[]) {
joshualitt47bb3822014-10-07 16:43:25 -0700460 GrGLint linked = GR_GL_INIT_ZERO;
461 GL_CALL(GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
462 if (!linked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400463 SkSL::String allShaders;
464 if (sksl) {
465 allShaders.appendf("// Vertex SKSL\n%s\n", sksl[kVertex_GrShaderType]->c_str());
466 if (!sksl[kGeometry_GrShaderType]->empty()) {
467 allShaders.appendf("// Geometry SKSL\n%s\n", sksl[kGeometry_GrShaderType]->c_str());
468 }
469 allShaders.appendf("// Fragment SKSL\n%s\n", sksl[kFragment_GrShaderType]->c_str());
470 }
471 if (glsl) {
472 allShaders.appendf("// Vertex GLSL\n%s\n", glsl[kVertex_GrShaderType].c_str());
473 if (!glsl[kGeometry_GrShaderType].empty()) {
474 allShaders.appendf("// Geometry GLSL\n%s\n", glsl[kGeometry_GrShaderType].c_str());
475 }
476 allShaders.appendf("// Fragment GLSL\n%s\n", glsl[kFragment_GrShaderType].c_str());
477 }
joshualitt47bb3822014-10-07 16:43:25 -0700478 GrGLint infoLen = GR_GL_INIT_ZERO;
479 GL_CALL(GetProgramiv(programID, GR_GL_INFO_LOG_LENGTH, &infoLen));
480 SkAutoMalloc log(sizeof(char)*(infoLen+1)); // outside if for debugger
481 if (infoLen > 0) {
482 // retrieve length even though we don't need it to workaround
483 // bug in chrome cmd buffer param validation.
484 GrGLsizei length = GR_GL_INIT_ZERO;
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400485 GL_CALL(GetProgramInfoLog(programID, infoLen+1, &length, (char*)log.get()));
joshualitt47bb3822014-10-07 16:43:25 -0700486 }
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400487 errorHandler->compileError(allShaders.c_str(), infoLen > 0 ? (const char*)log.get() : "");
joshualitt47bb3822014-10-07 16:43:25 -0700488 }
489 return SkToBool(linked);
490}
491
Brian Osman2c60a382019-06-26 15:19:30 -0400492void GrGLProgramBuilder::resolveProgramResourceLocations(GrGLuint programID, bool force) {
493 fUniformHandler.getUniformLocations(programID, fGpu->glCaps(), force);
joshualittd8dd47b2015-09-11 11:45:01 -0700494
495 // handle NVPR separable varyings
496 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
kkinnunen7bdb05d2016-01-25 00:47:23 -0800497 fGpu->glPathRendering()->shouldBindFragmentInputs()) {
joshualittd8dd47b2015-09-11 11:45:01 -0700498 return;
499 }
egdaniel0eafe792015-11-20 14:01:22 -0800500 int count = fVaryingHandler.fPathProcVaryingInfos.count();
joshualittd8dd47b2015-09-11 11:45:01 -0700501 for (int i = 0; i < count; ++i) {
502 GrGLint location;
egdaniel0eafe792015-11-20 14:01:22 -0800503 GL_CALL_RET(location, GetProgramResourceLocation(
504 programID,
505 GR_GL_FRAGMENT_INPUT,
506 fVaryingHandler.fPathProcVaryingInfos[i].fVariable.c_str()));
507 fVaryingHandler.fPathProcVaryingInfos[i].fLocation = location;
joshualittd8dd47b2015-09-11 11:45:01 -0700508 }
joshualitt30ba4362014-08-21 20:18:45 -0700509}
510
joshualitt47bb3822014-10-07 16:43:25 -0700511GrGLProgram* GrGLProgramBuilder::createProgram(GrGLuint programID) {
egdaniel7ea439b2015-12-03 09:20:44 -0800512 return new GrGLProgram(fGpu,
egdaniel7ea439b2015-12-03 09:20:44 -0800513 fUniformHandles,
514 programID,
515 fUniformHandler.fUniforms,
egdaniel09aa1fc2016-04-20 07:09:46 -0700516 fUniformHandler.fSamplers,
egdaniel0eafe792015-11-20 14:01:22 -0800517 fVaryingHandler.fPathProcVaryingInfos,
Robert Phillips369e8b72017-08-01 16:13:04 -0400518 std::move(fGeometryProcessor),
519 std::move(fXferProcessor),
Brian Salomon4d3f5172018-06-07 14:42:52 -0400520 std::move(fFragmentProcessors),
Brian Salomon802cb312018-06-08 18:05:20 -0400521 fFragmentProcessorCnt,
522 std::move(fAttributes),
Brian Salomon92be2f72018-06-19 14:33:47 -0400523 fVertexAttributeCnt,
524 fInstanceAttributeCnt,
Brian Salomon802cb312018-06-08 18:05:20 -0400525 fVertexStride,
526 fInstanceStride);
joshualitt47bb3822014-10-07 16:43:25 -0700527}
Brian Osmaned58e002019-09-06 14:42:43 -0400528
529bool GrGLProgramBuilder::PrecompileProgram(GrGLPrecompiledProgram* precompiledProgram,
530 GrGLGpu* gpu,
531 const SkData& cachedData) {
532 SkReader32 reader(cachedData.data(), cachedData.size());
533 SkFourByteTag shaderType = reader.readU32();
534 if (shaderType != kSKSL_Tag) {
535 // TODO: Support GLSL, and maybe even program binaries, too?
536 return false;
537 }
538
539 const GrGLInterface* gl = gpu->glInterface();
540 auto errorHandler = gpu->getContext()->priv().getShaderErrorHandler();
541 GrGLuint programID;
542 GR_GL_CALL_RET(gl, programID, CreateProgram());
543 if (0 == programID) {
544 return false;
545 }
546
547 SkTDArray<GrGLuint> shadersToDelete;
548
549 SkSL::Program::Settings settings;
Brian Osman4524e842019-09-24 16:03:41 -0400550 const GrGLCaps& caps = gpu->glCaps();
551 settings.fCaps = caps.shaderCaps();
Brian Osmaned58e002019-09-06 14:42:43 -0400552 settings.fSharpenTextures = gpu->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Osman4524e842019-09-24 16:03:41 -0400553 GrPersistentCacheUtils::ShaderMetadata meta;
554 meta.fSettings = &settings;
Brian Osmaned58e002019-09-06 14:42:43 -0400555
556 SkSL::String shaders[kGrShaderTypeCount];
557 SkSL::Program::Inputs inputs;
Brian Osman4524e842019-09-24 16:03:41 -0400558 GrPersistentCacheUtils::UnpackCachedShaders(&reader, shaders, &inputs, 1, &meta);
Brian Osmaned58e002019-09-06 14:42:43 -0400559
560 auto compileShader = [&](SkSL::Program::Kind kind, const SkSL::String& sksl, GrGLenum type) {
561 SkSL::String glsl;
562 auto program = GrSkSLtoGLSL(gpu->glContext(), kind, sksl, settings, &glsl, errorHandler);
563 if (!program) {
564 return false;
565 }
566
567 if (GrGLuint shaderID = GrGLCompileAndAttachShader(gpu->glContext(), programID, type, glsl,
568 gpu->stats(), errorHandler)) {
569 shadersToDelete.push_back(shaderID);
570 return true;
571 } else {
572 return false;
573 }
574 };
575
576 if (!compileShader(SkSL::Program::kFragment_Kind,
577 shaders[kFragment_GrShaderType],
578 GR_GL_FRAGMENT_SHADER) ||
579 !compileShader(SkSL::Program::kVertex_Kind,
580 shaders[kVertex_GrShaderType],
581 GR_GL_VERTEX_SHADER) ||
582 (!shaders[kGeometry_GrShaderType].empty() &&
583 !compileShader(SkSL::Program::kGeometry_Kind,
584 shaders[kGeometry_GrShaderType],
585 GR_GL_GEOMETRY_SHADER))) {
586 cleanup_program(gpu, programID, shadersToDelete);
587 return false;
588 }
589
Brian Osman4524e842019-09-24 16:03:41 -0400590 for (int i = 0; i < meta.fAttributeNames.count(); ++i) {
591 GR_GL_CALL(gpu->glInterface(), BindAttribLocation(programID, i,
592 meta.fAttributeNames[i].c_str()));
593 }
594
595 if (meta.fHasCustomColorOutput && caps.bindFragDataLocationSupport()) {
596 GR_GL_CALL(gpu->glInterface(), BindFragDataLocation(programID, 0,
597 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
598 }
599 if (meta.fHasSecondaryColorOutput && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
600 GR_GL_CALL(gpu->glInterface(), BindFragDataLocationIndexed(programID, 0, 1,
601 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
602 }
603
Brian Osmaned58e002019-09-06 14:42:43 -0400604 GR_GL_CALL(gpu->glInterface(), LinkProgram(programID));
605 GrGLint linked = GR_GL_INIT_ZERO;
606 GR_GL_CALL(gpu->glInterface(), GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
607 if (!linked) {
608 cleanup_program(gpu, programID, shadersToDelete);
609 return false;
610 }
611
612 cleanup_shaders(gpu, shadersToDelete);
613
614 precompiledProgram->fProgramID = programID;
615 precompiledProgram->fInputs = inputs;
616 return true;
617}