blob: 7a152caf034813a72114ba7a7137aa0eda26c703 [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
Adlai Holler3d0359a2020-07-09 15:35:55 -040010#include "include/gpu/GrDirectContext.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050011#include "src/core/SkATrace.h"
12#include "src/core/SkAutoMalloc.h"
Brian Osman9e4e4c72020-06-10 07:19:34 -040013#include "src/core/SkReadBuffer.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050014#include "src/core/SkTraceEvent.h"
Brian Osman9e4e4c72020-06-10 07:19:34 -040015#include "src/core/SkWriteBuffer.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050016#include "src/gpu/GrAutoLocaleSetter.h"
17#include "src/gpu/GrContextPriv.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050018#include "src/gpu/GrPersistentCacheUtils.h"
19#include "src/gpu/GrProgramDesc.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050020#include "src/gpu/GrShaderCaps.h"
Brian Osmanac9be9d2019-05-01 10:29:34 -040021#include "src/gpu/GrShaderUtils.h"
Brian Salomon3ec1f542019-06-17 17:54:57 +000022#include "src/gpu/GrSwizzle.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050023#include "src/gpu/gl/GrGLGpu.h"
24#include "src/gpu/gl/GrGLProgram.h"
25#include "src/gpu/gl/builders/GrGLProgramBuilder.h"
26#include "src/gpu/gl/builders/GrGLShaderStringBuilder.h"
27#include "src/gpu/glsl/GrGLSLFragmentProcessor.h"
28#include "src/gpu/glsl/GrGLSLGeometryProcessor.h"
29#include "src/gpu/glsl/GrGLSLProgramDataManager.h"
30#include "src/gpu/glsl/GrGLSLXferProcessor.h"
joshualitt30ba4362014-08-21 20:18:45 -070031
joshualitt30ba4362014-08-21 20:18:45 -070032#define GL_CALL(X) GR_GL_CALL(this->gpu()->glInterface(), X)
33#define GL_CALL_RET(R, X) GR_GL_CALL_RET(this->gpu()->glInterface(), R, X)
34
Brian Osmaned58e002019-09-06 14:42:43 -040035static void cleanup_shaders(GrGLGpu* gpu, const SkTDArray<GrGLuint>& shaderIDs) {
36 for (int i = 0; i < shaderIDs.count(); ++i) {
37 GR_GL_CALL(gpu->glInterface(), DeleteShader(shaderIDs[i]));
38 }
39}
40
41static void cleanup_program(GrGLGpu* gpu, GrGLuint programID,
42 const SkTDArray<GrGLuint>& shaderIDs) {
43 GR_GL_CALL(gpu->glInterface(), DeleteProgram(programID));
44 cleanup_shaders(gpu, shaderIDs);
45}
46
Stephen Whiteb1857852020-02-07 15:33:23 +000047sk_sp<GrGLProgram> GrGLProgramBuilder::CreateProgram(
Austin Eng77fdf662020-02-07 01:26:16 +000048 GrGLGpu* gpu,
Stephen Whiteb1857852020-02-07 15:33:23 +000049 GrRenderTarget* renderTarget,
50 const GrProgramDesc& desc,
51 const GrProgramInfo& programInfo,
Brian Osmaned58e002019-09-06 14:42:43 -040052 const GrGLPrecompiledProgram* precompiledProgram) {
Stan Iliev43324e72020-01-13 16:17:48 -050053 ATRACE_ANDROID_FRAMEWORK_ALWAYS("shader_compile");
bsalomon3318ee72015-03-16 11:56:29 -070054 GrAutoLocaleSetter als("C");
55
joshualitt47bb3822014-10-07 16:43:25 -070056 // create a builder. This will be handed off to effects so they can use it to add
57 // uniforms, varyings, textures, etc
Stephen Whiteb1857852020-02-07 15:33:23 +000058 GrGLProgramBuilder builder(gpu, renderTarget, desc, programInfo);
joshualitt47bb3822014-10-07 16:43:25 -070059
Robert Phillips9da87e02019-02-04 13:26:26 -050060 auto persistentCache = gpu->getContext()->priv().getPersistentCache();
Brian Osmaned58e002019-09-06 14:42:43 -040061 if (persistentCache && !precompiledProgram) {
Stephen Whiteb1857852020-02-07 15:33:23 +000062 sk_sp<SkData> key = SkData::MakeWithoutCopy(desc.asKey(), desc.keyLength());
Robert Phillips0c4b7b12018-03-06 08:20:37 -050063 builder.fCached = persistentCache->load(*key);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -040064 // the eventual end goal is to completely skip emitAndInstallProcs on a cache hit, but it's
65 // doing necessary setup in addition to generating the SkSL code. Currently we are only able
66 // to skip the SkSL->GLSL step on a cache hit.
67 }
Ethan Nicholas2983f402017-05-08 09:36:08 -040068 if (!builder.emitAndInstallProcs()) {
halcanary96fcdcc2015-08-27 07:41:13 -070069 return nullptr;
joshualitt6c891102015-05-13 08:51:49 -070070 }
Brian Osmaned58e002019-09-06 14:42:43 -040071 return builder.finalize(precompiledProgram);
joshualitt47bb3822014-10-07 16:43:25 -070072}
73
joshualitt47bb3822014-10-07 16:43:25 -070074/////////////////////////////////////////////////////////////////////////////
75
egdaniel0e1853c2016-03-17 11:35:45 -070076GrGLProgramBuilder::GrGLProgramBuilder(GrGLGpu* gpu,
Robert Phillipsd0fe8752019-01-31 14:13:59 -050077 GrRenderTarget* renderTarget,
Stephen Whiteb1857852020-02-07 15:33:23 +000078 const GrProgramDesc& desc,
79 const GrProgramInfo& programInfo)
80 : INHERITED(renderTarget, desc, programInfo)
Brian Salomon802cb312018-06-08 18:05:20 -040081 , fGpu(gpu)
82 , fVaryingHandler(this)
83 , fUniformHandler(this)
Brian Salomon92be2f72018-06-19 14:33:47 -040084 , fVertexAttributeCnt(0)
85 , fInstanceAttributeCnt(0)
Brian Salomon802cb312018-06-08 18:05:20 -040086 , fVertexStride(0)
87 , fInstanceStride(0) {}
joshualitt30ba4362014-08-21 20:18:45 -070088
egdanielfa896322016-01-13 12:19:30 -080089const GrCaps* GrGLProgramBuilder::caps() const {
90 return fGpu->caps();
91}
92
Brian Osmanac9be9d2019-05-01 10:29:34 -040093bool GrGLProgramBuilder::compileAndAttachShaders(const SkSL::String& glsl,
egdaniel574a4c12015-11-02 06:22:44 -080094 GrGLuint programId,
95 GrGLenum type,
Ethan Nicholas941e7e22016-12-12 15:33:30 -050096 SkTDArray<GrGLuint>* shaderIds,
Brian Osman5e7fbfd2019-05-03 13:13:35 -040097 GrContextOptions::ShaderErrorHandler* errHandler) {
egdaniel574a4c12015-11-02 06:22:44 -080098 GrGLGpu* gpu = this->gpu();
99 GrGLuint shaderId = GrGLCompileAndAttachShader(gpu->glContext(),
100 programId,
101 type,
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400102 glsl,
Brian Osman8518f2e2019-05-01 14:13:41 -0400103 gpu->stats(),
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400104 errHandler);
egdaniel574a4c12015-11-02 06:22:44 -0800105 if (!shaderId) {
106 return false;
107 }
108
109 *shaderIds->append() = shaderId;
egdaniel574a4c12015-11-02 06:22:44 -0800110 return true;
111}
112
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400113void GrGLProgramBuilder::computeCountsAndStrides(GrGLuint programID,
114 const GrPrimitiveProcessor& primProc,
115 bool bindAttribLocations) {
116 fVertexAttributeCnt = primProc.numVertexAttributes();
117 fInstanceAttributeCnt = primProc.numInstanceAttributes();
118 fAttributes.reset(
119 new GrGLProgram::Attribute[fVertexAttributeCnt + fInstanceAttributeCnt]);
120 auto addAttr = [&](int i, const auto& a, size_t* stride) {
Brian Osman4a3f5c82018-09-18 16:16:38 -0400121 fAttributes[i].fCPUType = a.cpuType();
122 fAttributes[i].fGPUType = a.gpuType();
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400123 fAttributes[i].fOffset = *stride;
124 *stride += a.sizeAlign4();
125 fAttributes[i].fLocation = i;
126 if (bindAttribLocations) {
127 GL_CALL(BindAttribLocation(programID, i, a.name()));
128 }
129 };
130 fVertexStride = 0;
131 int i = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500132 for (const auto& attr : primProc.vertexAttributes()) {
133 addAttr(i++, attr, &fVertexStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400134 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500135 SkASSERT(fVertexStride == primProc.vertexStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400136 fInstanceStride = 0;
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500137 for (const auto& attr : primProc.instanceAttributes()) {
138 addAttr(i++, attr, &fInstanceStride);
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400139 }
Brian Osmanf04fb3c2018-11-12 15:34:00 -0500140 SkASSERT(fInstanceStride == primProc.instanceStride());
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400141}
142
Ethan Nicholascd700e92018-08-24 16:43:57 -0400143void GrGLProgramBuilder::addInputVars(const SkSL::Program::Inputs& inputs) {
144 if (inputs.fRTWidth) {
145 this->addRTWidthUniform(SKSL_RTWIDTH_NAME);
146 }
147 if (inputs.fRTHeight) {
148 this->addRTHeightUniform(SKSL_RTHEIGHT_NAME);
149 }
150}
151
Brian Osmana085a412019-04-25 09:44:43 -0400152static constexpr SkFourByteTag kSKSL_Tag = SkSetFourByteTag('S', 'K', 'S', 'L');
153static constexpr SkFourByteTag kGLSL_Tag = SkSetFourByteTag('G', 'L', 'S', 'L');
Brian Osmana66081d2019-09-03 14:59:26 -0400154static constexpr SkFourByteTag kGLPB_Tag = SkSetFourByteTag('G', 'L', 'P', 'B');
Brian Osmana085a412019-04-25 09:44:43 -0400155
Ethan Nicholas8d058832019-01-07 10:49:58 -0500156void GrGLProgramBuilder::storeShaderInCache(const SkSL::Program::Inputs& inputs, GrGLuint programID,
Brian Osmaned58e002019-09-06 14:42:43 -0400157 const SkSL::String shaders[], bool isSkSL,
Brian Osman4524e842019-09-24 16:03:41 -0400158 SkSL::Program::Settings* settings) {
Robert Phillips9da87e02019-02-04 13:26:26 -0500159 if (!this->gpu()->getContext()->priv().getPersistentCache()) {
Ethan Nicholas8d058832019-01-07 10:49:58 -0500160 return;
161 }
Stephen Whiteb1857852020-02-07 15:33:23 +0000162 sk_sp<SkData> key = SkData::MakeWithoutCopy(this->desc().asKey(), this->desc().keyLength());
Ethan Nicholas8d058832019-01-07 10:49:58 -0500163 if (fGpu->glCaps().programBinarySupport()) {
164 // binary cache
165 GrGLsizei length = 0;
166 GL_CALL(GetProgramiv(programID, GL_PROGRAM_BINARY_LENGTH, &length));
167 if (length > 0) {
Brian Osman9e4e4c72020-06-10 07:19:34 -0400168 SkBinaryWriteBuffer writer;
169 writer.writeInt(GrPersistentCacheUtils::kCurrentVersion);
170 writer.writeUInt(kGLPB_Tag);
Brian Osmana66081d2019-09-03 14:59:26 -0400171
Brian Osman9e4e4c72020-06-10 07:19:34 -0400172 writer.writePad32(&inputs, sizeof(inputs));
Brian Osman6b797fe2019-04-08 13:56:36 -0400173
Brian Osman9e4e4c72020-06-10 07:19:34 -0400174 SkAutoSMalloc<2048> binary(length);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500175 GrGLenum binaryFormat;
Brian Osman9e4e4c72020-06-10 07:19:34 -0400176 GL_CALL(GetProgramBinary(programID, length, &length, &binaryFormat, binary.get()));
177
178 writer.writeUInt(binaryFormat);
179 writer.writeInt(length);
180 writer.writePad32(binary.get(), length);
Brian Osman6b797fe2019-04-08 13:56:36 -0400181
182 auto data = writer.snapshotAsData();
183 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500184 }
185 } else {
Brian Osman4524e842019-09-24 16:03:41 -0400186 // source cache, plus metadata to allow for a complete precompile
187 GrPersistentCacheUtils::ShaderMetadata meta;
188 meta.fSettings = settings;
189 meta.fHasCustomColorOutput = fFS.hasCustomColorOutput();
190 meta.fHasSecondaryColorOutput = fFS.hasSecondaryOutput();
191 for (const auto& attr : this->primitiveProcessor().vertexAttributes()) {
192 meta.fAttributeNames.emplace_back(attr.name());
193 }
194 for (const auto& attr : this->primitiveProcessor().instanceAttributes()) {
195 meta.fAttributeNames.emplace_back(attr.name());
196 }
197
Brian Osmana085a412019-04-25 09:44:43 -0400198 auto data = GrPersistentCacheUtils::PackCachedShaders(isSkSL ? kSKSL_Tag : kGLSL_Tag,
Brian Osman4524e842019-09-24 16:03:41 -0400199 shaders, &inputs, 1, &meta);
Brian Osman6b797fe2019-04-08 13:56:36 -0400200 this->gpu()->getContext()->priv().getPersistentCache()->store(*key, *data);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500201 }
202}
203
Stephen Whiteb1857852020-02-07 15:33:23 +0000204sk_sp<GrGLProgram> GrGLProgramBuilder::finalize(const GrGLPrecompiledProgram* precompiledProgram) {
Brian Salomon5f394272019-07-02 14:07:49 -0400205 TRACE_EVENT0("skia.gpu", TRACE_FUNC);
Ryan Macnak38a10ad2017-07-10 10:36:34 -0700206
joshualitt47bb3822014-10-07 16:43:25 -0700207 // verify we can get a program id
208 GrGLuint programID;
Brian Osmaned58e002019-09-06 14:42:43 -0400209 if (precompiledProgram) {
210 programID = precompiledProgram->fProgramID;
211 } else {
212 GL_CALL_RET(programID, CreateProgram());
213 }
joshualitt47bb3822014-10-07 16:43:25 -0700214 if (0 == programID) {
halcanary96fcdcc2015-08-27 07:41:13 -0700215 return nullptr;
joshualitt30ba4362014-08-21 20:18:45 -0700216 }
217
Ethan Nicholas06d55fb2017-11-08 09:48:50 -0500218 if (this->gpu()->glCaps().programBinarySupport() &&
Brian Osman064729e2019-06-18 17:22:59 -0400219 this->gpu()->glCaps().programParameterSupport() &&
Brian Osmaned58e002019-09-06 14:42:43 -0400220 this->gpu()->getContext()->priv().getPersistentCache() &&
221 !precompiledProgram) {
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400222 GL_CALL(ProgramParameteri(programID, GR_GL_PROGRAM_BINARY_RETRIEVABLE_HINT, GR_GL_TRUE));
223 }
224
egdaniel9f1d4152016-02-10 09:50:38 -0800225 this->finalizeShaders();
226
joshualitt47bb3822014-10-07 16:43:25 -0700227 // compile shaders and bind attributes / uniforms
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400228 auto errorHandler = this->gpu()->getContext()->priv().getShaderErrorHandler();
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400229 const GrPrimitiveProcessor& primProc = this->primitiveProcessor();
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500230 SkSL::Program::Settings settings;
231 settings.fCaps = this->gpu()->glCaps().shaderCaps();
Robert Phillipsd0fe8752019-01-31 14:13:59 -0500232 settings.fFlipY = this->origin() != kTopLeft_GrSurfaceOrigin;
Robert Phillipsc1541ae2019-02-04 12:05:37 -0500233 settings.fSharpenTextures =
Robert Phillips9da87e02019-02-04 13:26:26 -0500234 this->gpu()->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Salomondc092132018-04-04 10:14:16 -0400235 settings.fFragColorIsInOut = this->fragColorIsInOut();
236
Ethan Nicholas941e7e22016-12-12 15:33:30 -0500237 SkSL::Program::Inputs inputs;
joshualitt30ba4362014-08-21 20:18:45 -0700238 SkTDArray<GrGLuint> shadersToDelete;
Brian Salomond8575452020-02-25 12:13:29 -0500239
240 bool checkLinked = !fGpu->glCaps().skipErrorChecks();
241
Ethan Nicholas8d058832019-01-07 10:49:58 -0500242 bool cached = fCached.get() != nullptr;
Brian Osman2c60a382019-06-26 15:19:30 -0400243 bool usedProgramBinaries = false;
Brian Osman6b797fe2019-04-08 13:56:36 -0400244 SkSL::String glsl[kGrShaderTypeCount];
Brian Osmancbc33b82019-04-19 14:16:19 -0400245 SkSL::String* sksl[kGrShaderTypeCount] = {
246 &fVS.fCompilerString,
247 &fGS.fCompilerString,
248 &fFS.fCompilerString,
249 };
Brian Osmancbc33b82019-04-19 14:16:19 -0400250 SkSL::String cached_sksl[kGrShaderTypeCount];
Brian Osmaned58e002019-09-06 14:42:43 -0400251 if (precompiledProgram) {
252 // This is very similar to when we get program binaries. We even set that flag, as it's
253 // used to prevent other compile work later, and to force re-querying uniform locations.
254 this->addInputVars(precompiledProgram->fInputs);
Brian Osman4524e842019-09-24 16:03:41 -0400255 this->computeCountsAndStrides(programID, primProc, false);
Brian Osmaned58e002019-09-06 14:42:43 -0400256 usedProgramBinaries = true;
257 } else if (cached) {
Stan Iliev43324e72020-01-13 16:17:48 -0500258 ATRACE_ANDROID_FRAMEWORK_ALWAYS("cache_hit");
Brian Osman9e4e4c72020-06-10 07:19:34 -0400259 SkReadBuffer reader(fCached->data(), fCached->size());
Brian Osman1facd5e2020-03-16 16:21:24 -0400260 SkFourByteTag shaderType = GrPersistentCacheUtils::GetType(&reader);
Brian Osmana66081d2019-09-03 14:59:26 -0400261
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 Osman9e4e4c72020-06-10 07:19:34 -0400270 reader.readPad32(&inputs, sizeof(inputs));
271 GrGLenum binaryFormat = reader.readUInt();
272 GrGLsizei length = reader.readInt();
Brian Osmana66081d2019-09-03 14:59:26 -0400273 const void* binary = reader.skip(length);
Brian Osman9e4e4c72020-06-10 07:19:34 -0400274 if (!reader.isValid()) {
275 break;
276 }
Brian Salomon24069eb2020-06-24 10:19:52 -0400277 this->gpu()->clearErrorsAndCheckForOOM();
Brian Osmana66081d2019-09-03 14:59:26 -0400278 GR_GL_CALL_NOERRCHECK(this->gpu()->glInterface(),
279 ProgramBinary(programID, binaryFormat,
280 const_cast<void*>(binary), length));
Brian Salomon24069eb2020-06-24 10:19:52 -0400281 if (this->gpu()->getErrorAndCheckForOOM() == GR_GL_NO_ERROR) {
Brian Osmana66081d2019-09-03 14:59:26 -0400282 if (checkLinked) {
283 cached = this->checkLinkStatus(programID, errorHandler, nullptr, nullptr);
284 }
285 if (cached) {
286 this->addInputVars(inputs);
287 this->computeCountsAndStrides(programID, primProc, false);
288 }
289 } else {
290 cached = false;
Ethan Nicholas8d058832019-01-07 10:49:58 -0500291 }
Brian Osmana66081d2019-09-03 14:59:26 -0400292 usedProgramBinaries = cached;
293 break;
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400294 }
Brian Osmana66081d2019-09-03 14:59:26 -0400295
296 case kGLSL_Tag:
297 // Source cache hit, we don't need to compile the SkSL->GLSL
298 GrPersistentCacheUtils::UnpackCachedShaders(&reader, glsl, &inputs, 1);
299 break;
300
301 case kSKSL_Tag:
302 // SkSL cache hit, this should only happen in tools overriding the generated SkSL
Brian Osman9e4e4c72020-06-10 07:19:34 -0400303 if (GrPersistentCacheUtils::UnpackCachedShaders(&reader, cached_sksl, &inputs, 1)) {
304 for (int i = 0; i < kGrShaderTypeCount; ++i) {
305 sksl[i] = &cached_sksl[i];
306 }
Brian Osmana085a412019-04-25 09:44:43 -0400307 }
Brian Osmana66081d2019-09-03 14:59:26 -0400308 break;
Brian Osman43f443f2020-06-05 11:11:36 -0400309
310 default:
311 // We got something invalid, so pretend it wasn't there
Brian Osman9e4e4c72020-06-10 07:19:34 -0400312 reader.validate(false);
Brian Osman43f443f2020-06-05 11:11:36 -0400313 break;
Ethan Nicholas98ad5b72018-03-13 09:53:02 -0400314 }
Brian Osman9e4e4c72020-06-10 07:19:34 -0400315 if (!reader.isValid()) {
316 cached = false;
317 }
Ethan Nicholas98ad5b72018-03-13 09:53:02 -0400318 }
Brian Osmana66081d2019-09-03 14:59:26 -0400319 if (!usedProgramBinaries) {
Stan Iliev43324e72020-01-13 16:17:48 -0500320 ATRACE_ANDROID_FRAMEWORK_ALWAYS("cache_miss");
Brian Osmanf7924452019-09-24 10:44:37 -0400321 // Either a cache miss, or we got something other than binaries from the cache
322
323 /*
324 Fragment Shader
325 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400326 if (glsl[kFragment_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400327 // Don't have cached GLSL, need to compile SkSL->GLSL
Ethan Nicholas8d058832019-01-07 10:49:58 -0500328 if (fFS.fForceHighPrecision) {
329 settings.fForceHighPrecision = true;
330 }
331 std::unique_ptr<SkSL::Program> fs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400332 SkSL::Program::kFragment_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400333 *sksl[kFragment_GrShaderType],
Ethan Nicholas8d058832019-01-07 10:49:58 -0500334 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400335 &glsl[kFragment_GrShaderType],
336 errorHandler);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500337 if (!fs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400338 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas8d058832019-01-07 10:49:58 -0500339 return nullptr;
340 }
341 inputs = fs->fInputs;
egdaniel8dcdedc2015-11-11 06:27:20 -0800342 }
Brian Osmanf7924452019-09-24 10:44:37 -0400343
344 this->addInputVars(inputs);
Brian Osmanac9be9d2019-05-01 10:29:34 -0400345 if (!this->compileAndAttachShaders(glsl[kFragment_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400346 GR_GL_FRAGMENT_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400347 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400348 return nullptr;
349 }
350
Brian Osmanf7924452019-09-24 10:44:37 -0400351 /*
352 Vertex Shader
353 */
Brian Osman6b797fe2019-04-08 13:56:36 -0400354 if (glsl[kVertex_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400355 // Don't have cached GLSL, need to compile SkSL->GLSL
356 std::unique_ptr<SkSL::Program> vs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400357 SkSL::Program::kVertex_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400358 *sksl[kVertex_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400359 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400360 &glsl[kVertex_GrShaderType],
361 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400362 if (!vs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400363 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400364 return nullptr;
365 }
366 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400367 if (!this->compileAndAttachShaders(glsl[kVertex_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400368 GR_GL_VERTEX_SHADER, &shadersToDelete, errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400369 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400370 return nullptr;
371 }
372
Brian Osmanf7924452019-09-24 10:44:37 -0400373 // This also binds vertex attribute locations. NVPR doesn't really use vertices,
374 // even though it requires a vertex shader in the program.
375 if (!primProc.isPathRendering()) {
Ethan Nicholasad77dce2018-07-11 13:59:03 -0400376 this->computeCountsAndStrides(programID, primProc, true);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400377 }
378
Brian Osmanf7924452019-09-24 10:44:37 -0400379 /*
Chris Dalton5a2f9622019-12-27 14:56:38 -0700380 Tessellation Shaders
381 */
382 if (fProgramInfo.primProc().willUseTessellationShaders()) {
383 // Tessellation shaders are not currently supported by SkSL. So here, we temporarily
384 // generate GLSL strings directly using back door methods on GrPrimitiveProcessor, and
385 // pass those raw strings on to the driver.
386 SkString versionAndExtensionDecls;
387 versionAndExtensionDecls.appendf("%s\n", this->shaderCaps()->versionDeclString());
388 if (const char* extensionString = this->shaderCaps()->tessellationExtensionString()) {
389 versionAndExtensionDecls.appendf("#extension %s : require\n", extensionString);
390 }
391
392 SkString tessControlShader = primProc.getTessControlShaderGLSL(
Chris Dalton54c90932020-06-24 10:51:52 -0600393 fGeometryProcessor.get(), versionAndExtensionDecls.c_str(), fUniformHandler,
394 *this->shaderCaps());
Chris Dalton5a2f9622019-12-27 14:56:38 -0700395 if (!this->compileAndAttachShaders(tessControlShader.c_str(), programID,
396 GR_GL_TESS_CONTROL_SHADER, &shadersToDelete,
397 errorHandler)) {
398 cleanup_program(fGpu, programID, shadersToDelete);
399 return nullptr;
400 }
401
402 SkString tessEvaluationShader = primProc.getTessEvaluationShaderGLSL(
Chris Dalton54c90932020-06-24 10:51:52 -0600403 fGeometryProcessor.get(), versionAndExtensionDecls.c_str(), fUniformHandler,
404 *this->shaderCaps());
Chris Dalton5a2f9622019-12-27 14:56:38 -0700405 if (!this->compileAndAttachShaders(tessEvaluationShader.c_str(), programID,
406 GR_GL_TESS_EVALUATION_SHADER, &shadersToDelete,
407 errorHandler)) {
408 cleanup_program(fGpu, programID, shadersToDelete);
409 return nullptr;
410 }
411 }
412
413 /*
Brian Osmanf7924452019-09-24 10:44:37 -0400414 Geometry Shader
415 */
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400416 if (primProc.willUseGeoShader()) {
Brian Osman6b797fe2019-04-08 13:56:36 -0400417 if (glsl[kGeometry_GrShaderType].empty()) {
Brian Osmanf71b0702019-04-03 13:04:16 -0400418 // Don't have cached GLSL, need to compile SkSL->GLSL
419 std::unique_ptr<SkSL::Program> gs;
420 gs = GrSkSLtoGLSL(gpu()->glContext(),
Brian Osmanac9be9d2019-05-01 10:29:34 -0400421 SkSL::Program::kGeometry_Kind,
Brian Osmancbc33b82019-04-19 14:16:19 -0400422 *sksl[kGeometry_GrShaderType],
Brian Osmanf71b0702019-04-03 13:04:16 -0400423 settings,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400424 &glsl[kGeometry_GrShaderType],
425 errorHandler);
Brian Osmanf71b0702019-04-03 13:04:16 -0400426 if (!gs) {
Brian Osmaned58e002019-09-06 14:42:43 -0400427 cleanup_program(fGpu, programID, shadersToDelete);
Brian Osmanf71b0702019-04-03 13:04:16 -0400428 return nullptr;
429 }
430 }
Brian Osmanac9be9d2019-05-01 10:29:34 -0400431 if (!this->compileAndAttachShaders(glsl[kGeometry_GrShaderType], programID,
Brian Osmane11dfd32019-07-23 10:29:41 -0400432 GR_GL_GEOMETRY_SHADER, &shadersToDelete,
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400433 errorHandler)) {
Brian Osmaned58e002019-09-06 14:42:43 -0400434 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400435 return nullptr;
436 }
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400437 }
438 this->bindProgramResourceLocations(programID);
439
440 GL_CALL(LinkProgram(programID));
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500441 if (checkLinked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400442 if (!this->checkLinkStatus(programID, errorHandler, sksl, glsl)) {
Brian Osman2ab2ac02019-09-09 13:54:54 -0400443 cleanup_program(fGpu, programID, shadersToDelete);
Ethan Nicholas5a0338c2019-01-02 11:48:56 -0500444 return nullptr;
Brian Salomone334c592017-05-15 11:00:58 -0400445 }
Brian Salomone334c592017-05-15 11:00:58 -0400446 }
joshualittfe1233c2014-10-07 12:16:35 -0700447 }
Brian Osman2c60a382019-06-26 15:19:30 -0400448 this->resolveProgramResourceLocations(programID, usedProgramBinaries);
joshualittdb0d3ca2014-10-07 12:42:26 -0700449
Brian Osmaned58e002019-09-06 14:42:43 -0400450 cleanup_shaders(fGpu, shadersToDelete);
Brian Osmane4c88bb2019-06-27 16:15:11 -0400451
Chris Dalton5a2f9622019-12-27 14:56:38 -0700452 // We temporarily can't cache tessellation shaders while using back door GLSL.
453 //
Brian Osmaned58e002019-09-06 14:42:43 -0400454 // We also can't cache SkSL or GLSL if we were given a precompiled program, but there's not
455 // much point in doing so.
Brian Osman0b22f3b2020-03-23 13:21:24 -0400456 if (!cached && !primProc.willUseTessellationShaders() && !precompiledProgram) {
Chris Dalton8dae7eb2019-12-27 22:20:55 -0700457 // FIXME: Remove the check for tessellation shaders in the above 'if' once the back door
458 // GLSL mechanism is removed.
459 (void)&GrPrimitiveProcessor::getTessControlShaderGLSL;
Brian Osmana085a412019-04-25 09:44:43 -0400460 bool isSkSL = false;
Brian Osmana66081d2019-09-03 14:59:26 -0400461 if (fGpu->getContext()->priv().options().fShaderCacheStrategy ==
462 GrContextOptions::ShaderCacheStrategy::kSkSL) {
Brian Osmancbc33b82019-04-19 14:16:19 -0400463 for (int i = 0; i < kGrShaderTypeCount; ++i) {
Brian Osmanac9be9d2019-05-01 10:29:34 -0400464 glsl[i] = GrShaderUtils::PrettyPrint(*sksl[i]);
Brian Osmancbc33b82019-04-19 14:16:19 -0400465 }
Brian Osmana085a412019-04-25 09:44:43 -0400466 isSkSL = true;
Brian Osmancbc33b82019-04-19 14:16:19 -0400467 }
Brian Osman4524e842019-09-24 16:03:41 -0400468 this->storeShaderInCache(inputs, programID, glsl, isSkSL, &settings);
Ethan Nicholasd1b2eec2017-11-01 15:45:43 -0400469 }
joshualitt47bb3822014-10-07 16:43:25 -0700470 return this->createProgram(programID);
471}
472
kkinnunen7aedda52015-06-29 23:01:28 -0700473void GrGLProgramBuilder::bindProgramResourceLocations(GrGLuint programID) {
egdaniel7ea439b2015-12-03 09:20:44 -0800474 fUniformHandler.bindUniformLocations(programID, fGpu->glCaps());
kkinnunen7aedda52015-06-29 23:01:28 -0700475
egdaniel8dcdedc2015-11-11 06:27:20 -0800476 const GrGLCaps& caps = this->gpu()->glCaps();
477 if (fFS.hasCustomColorOutput() && caps.bindFragDataLocationSupport()) {
478 GL_CALL(BindFragDataLocation(programID, 0,
egdaniel2d721d32015-11-11 13:06:05 -0800479 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800480 }
Brian Salomon1edc5b92016-11-29 13:43:46 -0500481 if (fFS.hasSecondaryOutput() && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
egdaniel8dcdedc2015-11-11 06:27:20 -0800482 GL_CALL(BindFragDataLocationIndexed(programID, 0, 1,
egdaniel2d721d32015-11-11 13:06:05 -0800483 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
egdaniel8dcdedc2015-11-11 06:27:20 -0800484 }
joshualittd8dd47b2015-09-11 11:45:01 -0700485
486 // handle NVPR separable varyings
487 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
488 !fGpu->glPathRendering()->shouldBindFragmentInputs()) {
489 return;
490 }
Michael Ludwig45191342020-03-24 12:29:39 -0400491 int i = 0;
492 for (auto& varying : fVaryingHandler.fPathProcVaryingInfos.items()) {
493 GL_CALL(BindFragmentInputLocation(programID, i, varying.fVariable.c_str()));
494 varying.fLocation = i;
495 ++i;
joshualittd8dd47b2015-09-11 11:45:01 -0700496 }
joshualitt47bb3822014-10-07 16:43:25 -0700497}
498
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400499bool GrGLProgramBuilder::checkLinkStatus(GrGLuint programID,
500 GrContextOptions::ShaderErrorHandler* errorHandler,
501 SkSL::String* sksl[], const SkSL::String glsl[]) {
joshualitt47bb3822014-10-07 16:43:25 -0700502 GrGLint linked = GR_GL_INIT_ZERO;
503 GL_CALL(GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
504 if (!linked) {
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400505 SkSL::String allShaders;
506 if (sksl) {
507 allShaders.appendf("// Vertex SKSL\n%s\n", sksl[kVertex_GrShaderType]->c_str());
508 if (!sksl[kGeometry_GrShaderType]->empty()) {
509 allShaders.appendf("// Geometry SKSL\n%s\n", sksl[kGeometry_GrShaderType]->c_str());
510 }
511 allShaders.appendf("// Fragment SKSL\n%s\n", sksl[kFragment_GrShaderType]->c_str());
512 }
513 if (glsl) {
514 allShaders.appendf("// Vertex GLSL\n%s\n", glsl[kVertex_GrShaderType].c_str());
515 if (!glsl[kGeometry_GrShaderType].empty()) {
516 allShaders.appendf("// Geometry GLSL\n%s\n", glsl[kGeometry_GrShaderType].c_str());
517 }
518 allShaders.appendf("// Fragment GLSL\n%s\n", glsl[kFragment_GrShaderType].c_str());
519 }
joshualitt47bb3822014-10-07 16:43:25 -0700520 GrGLint infoLen = GR_GL_INIT_ZERO;
521 GL_CALL(GetProgramiv(programID, GR_GL_INFO_LOG_LENGTH, &infoLen));
522 SkAutoMalloc log(sizeof(char)*(infoLen+1)); // outside if for debugger
523 if (infoLen > 0) {
524 // retrieve length even though we don't need it to workaround
525 // bug in chrome cmd buffer param validation.
526 GrGLsizei length = GR_GL_INIT_ZERO;
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400527 GL_CALL(GetProgramInfoLog(programID, infoLen+1, &length, (char*)log.get()));
joshualitt47bb3822014-10-07 16:43:25 -0700528 }
Brian Osman5e7fbfd2019-05-03 13:13:35 -0400529 errorHandler->compileError(allShaders.c_str(), infoLen > 0 ? (const char*)log.get() : "");
joshualitt47bb3822014-10-07 16:43:25 -0700530 }
531 return SkToBool(linked);
532}
533
Brian Osman2c60a382019-06-26 15:19:30 -0400534void GrGLProgramBuilder::resolveProgramResourceLocations(GrGLuint programID, bool force) {
535 fUniformHandler.getUniformLocations(programID, fGpu->glCaps(), force);
joshualittd8dd47b2015-09-11 11:45:01 -0700536
537 // handle NVPR separable varyings
538 if (!fGpu->glCaps().shaderCaps()->pathRenderingSupport() ||
kkinnunen7bdb05d2016-01-25 00:47:23 -0800539 fGpu->glPathRendering()->shouldBindFragmentInputs()) {
joshualittd8dd47b2015-09-11 11:45:01 -0700540 return;
541 }
Michael Ludwig45191342020-03-24 12:29:39 -0400542 for (auto& varying : fVaryingHandler.fPathProcVaryingInfos.items()) {
joshualittd8dd47b2015-09-11 11:45:01 -0700543 GrGLint location;
egdaniel0eafe792015-11-20 14:01:22 -0800544 GL_CALL_RET(location, GetProgramResourceLocation(
545 programID,
546 GR_GL_FRAGMENT_INPUT,
Michael Ludwig45191342020-03-24 12:29:39 -0400547 varying.fVariable.c_str()));
548 varying.fLocation = location;
joshualittd8dd47b2015-09-11 11:45:01 -0700549 }
joshualitt30ba4362014-08-21 20:18:45 -0700550}
551
Stephen Whiteb1857852020-02-07 15:33:23 +0000552sk_sp<GrGLProgram> GrGLProgramBuilder::createProgram(GrGLuint programID) {
Robert Phillipsdf546db2020-05-29 09:42:54 -0400553 return GrGLProgram::Make(fGpu,
554 fUniformHandles,
555 programID,
556 fUniformHandler.fUniforms,
557 fUniformHandler.fSamplers,
558 fVaryingHandler.fPathProcVaryingInfos,
559 std::move(fGeometryProcessor),
560 std::move(fXferProcessor),
561 std::move(fFragmentProcessors),
Robert Phillipsdf546db2020-05-29 09:42:54 -0400562 std::move(fAttributes),
563 fVertexAttributeCnt,
564 fInstanceAttributeCnt,
565 fVertexStride,
566 fInstanceStride);
joshualitt47bb3822014-10-07 16:43:25 -0700567}
Brian Osmaned58e002019-09-06 14:42:43 -0400568
569bool GrGLProgramBuilder::PrecompileProgram(GrGLPrecompiledProgram* precompiledProgram,
570 GrGLGpu* gpu,
571 const SkData& cachedData) {
Brian Osman9e4e4c72020-06-10 07:19:34 -0400572 SkReadBuffer reader(cachedData.data(), cachedData.size());
Brian Osman1facd5e2020-03-16 16:21:24 -0400573 SkFourByteTag shaderType = GrPersistentCacheUtils::GetType(&reader);
Brian Osmaned58e002019-09-06 14:42:43 -0400574 if (shaderType != kSKSL_Tag) {
575 // TODO: Support GLSL, and maybe even program binaries, too?
576 return false;
577 }
578
579 const GrGLInterface* gl = gpu->glInterface();
580 auto errorHandler = gpu->getContext()->priv().getShaderErrorHandler();
Brian Osmaned58e002019-09-06 14:42:43 -0400581
582 SkSL::Program::Settings settings;
Brian Osman4524e842019-09-24 16:03:41 -0400583 const GrGLCaps& caps = gpu->glCaps();
584 settings.fCaps = caps.shaderCaps();
Brian Osmaned58e002019-09-06 14:42:43 -0400585 settings.fSharpenTextures = gpu->getContext()->priv().options().fSharpenMipmappedTextures;
Brian Osman4524e842019-09-24 16:03:41 -0400586 GrPersistentCacheUtils::ShaderMetadata meta;
587 meta.fSettings = &settings;
Brian Osmaned58e002019-09-06 14:42:43 -0400588
589 SkSL::String shaders[kGrShaderTypeCount];
590 SkSL::Program::Inputs inputs;
Brian Osman9e4e4c72020-06-10 07:19:34 -0400591 if (!GrPersistentCacheUtils::UnpackCachedShaders(&reader, shaders, &inputs, 1, &meta)) {
592 return false;
593 }
594
595 GrGLuint programID;
596 GR_GL_CALL_RET(gl, programID, CreateProgram());
597 if (0 == programID) {
598 return false;
599 }
600
601 SkTDArray<GrGLuint> shadersToDelete;
Brian Osmaned58e002019-09-06 14:42:43 -0400602
603 auto compileShader = [&](SkSL::Program::Kind kind, const SkSL::String& sksl, GrGLenum type) {
604 SkSL::String glsl;
605 auto program = GrSkSLtoGLSL(gpu->glContext(), kind, sksl, settings, &glsl, errorHandler);
606 if (!program) {
607 return false;
608 }
609
610 if (GrGLuint shaderID = GrGLCompileAndAttachShader(gpu->glContext(), programID, type, glsl,
611 gpu->stats(), errorHandler)) {
612 shadersToDelete.push_back(shaderID);
613 return true;
614 } else {
615 return false;
616 }
617 };
618
619 if (!compileShader(SkSL::Program::kFragment_Kind,
620 shaders[kFragment_GrShaderType],
621 GR_GL_FRAGMENT_SHADER) ||
622 !compileShader(SkSL::Program::kVertex_Kind,
623 shaders[kVertex_GrShaderType],
624 GR_GL_VERTEX_SHADER) ||
625 (!shaders[kGeometry_GrShaderType].empty() &&
626 !compileShader(SkSL::Program::kGeometry_Kind,
627 shaders[kGeometry_GrShaderType],
628 GR_GL_GEOMETRY_SHADER))) {
629 cleanup_program(gpu, programID, shadersToDelete);
630 return false;
631 }
632
Brian Osman4524e842019-09-24 16:03:41 -0400633 for (int i = 0; i < meta.fAttributeNames.count(); ++i) {
634 GR_GL_CALL(gpu->glInterface(), BindAttribLocation(programID, i,
635 meta.fAttributeNames[i].c_str()));
636 }
637
638 if (meta.fHasCustomColorOutput && caps.bindFragDataLocationSupport()) {
639 GR_GL_CALL(gpu->glInterface(), BindFragDataLocation(programID, 0,
640 GrGLSLFragmentShaderBuilder::DeclaredColorOutputName()));
641 }
642 if (meta.fHasSecondaryColorOutput && caps.shaderCaps()->mustDeclareFragmentShaderOutput()) {
643 GR_GL_CALL(gpu->glInterface(), BindFragDataLocationIndexed(programID, 0, 1,
644 GrGLSLFragmentShaderBuilder::DeclaredSecondaryColorOutputName()));
645 }
646
Brian Osmaned58e002019-09-06 14:42:43 -0400647 GR_GL_CALL(gpu->glInterface(), LinkProgram(programID));
648 GrGLint linked = GR_GL_INIT_ZERO;
649 GR_GL_CALL(gpu->glInterface(), GetProgramiv(programID, GR_GL_LINK_STATUS, &linked));
650 if (!linked) {
651 cleanup_program(gpu, programID, shadersToDelete);
652 return false;
653 }
654
655 cleanup_shaders(gpu, shadersToDelete);
656
657 precompiledProgram->fProgramID = programID;
658 precompiledProgram->fInputs = inputs;
659 return true;
660}