blob: cc81f297c5795f5d0d50272efb95dc333309af49 [file] [log] [blame]
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +00001//
Geoff Lang1b6edcb2014-02-03 14:27:56 -05002// Copyright (c) 2002-2014 The ANGLE Project Authors. All rights reserved.
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +00003// Use of this source code is governed by a BSD-style license that can be
4// found in the LICENSE file.
5//
6
7// Program.h: Defines the gl::Program class. Implements GL program objects
8// and related functionality. [OpenGL ES 2.0.24] section 2.10.3 page 28.
9
Geoff Lang0a73dd82014-11-19 16:18:08 -050010#ifndef LIBANGLE_PROGRAM_H_
11#define LIBANGLE_PROGRAM_H_
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000012
Geoff Lang0b7eef72014-06-12 14:10:47 -040013#include <GLES2/gl2.h>
Jamie Madill861ebb32016-11-17 16:40:22 -050014#include <GLSLANG/ShaderVars.h>
Geoff Lang0b7eef72014-06-12 14:10:47 -040015
Jamie Madilla7d12dc2016-12-13 15:08:19 -050016#include <array>
Jamie Madill861ebb32016-11-17 16:40:22 -050017#include <map>
Jamie Madill63805b42015-08-25 13:17:39 -040018#include <set>
Jamie Madill71c3b2c2015-05-07 11:49:20 -040019#include <sstream>
Geoff Lang0b7eef72014-06-12 14:10:47 -040020#include <string>
Jamie Madill63805b42015-08-25 13:17:39 -040021#include <vector>
Geoff Lang0b7eef72014-06-12 14:10:47 -040022
Jamie Madill3d3d2f22015-09-23 16:47:51 -040023#include "common/angleutils.h"
24#include "common/mathutil.h"
25#include "common/Optional.h"
26
Jamie Madill3d3d2f22015-09-23 16:47:51 -040027#include "libANGLE/Constants.h"
Geoff Lang70d0f492015-12-10 17:45:46 -050028#include "libANGLE/Debug.h"
Jamie Madill3d3d2f22015-09-23 16:47:51 -040029#include "libANGLE/Error.h"
30#include "libANGLE/RefCountObject.h"
jchen107a20b972017-06-13 14:25:26 +080031#include "libANGLE/Uniform.h"
32#include "libANGLE/angletypes.h"
Jamie Madill3d3d2f22015-09-23 16:47:51 -040033
shannon.woods@transgaming.com486d9e92013-02-28 23:15:41 +000034namespace rx
35{
Jamie Madill7aea7e02016-05-10 10:39:45 -040036class GLImplFactory;
Geoff Lang7dd2e102014-11-10 15:19:26 -050037class ProgramImpl;
Jamie Madill5c6b7bf2015-08-17 12:53:35 -040038struct TranslatedAttribute;
shannon.woods@transgaming.com486d9e92013-02-28 23:15:41 +000039}
daniel@transgaming.come6842292010-04-20 18:52:50 +000040
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000041namespace gl
42{
Brandon Jones43a53e22014-08-28 16:23:22 -070043struct Caps;
Jamie Madilla2c74982016-12-12 11:20:42 -050044class Context;
Jamie Madilldfde6ab2016-06-09 07:07:18 -070045class ContextState;
shannon.woods@transgaming.com486d9e92013-02-28 23:15:41 +000046class Shader;
Geoff Lang4ddf5af2016-12-01 14:30:44 -050047class ShaderProgramManager;
Jamie Madillf4f8db82017-02-15 09:31:39 -050048class State;
Geoff Lang7dd2e102014-11-10 15:19:26 -050049class InfoLog;
Geoff Lang7dd2e102014-11-10 15:19:26 -050050class Buffer;
51class Framebuffer;
Jamie Madill192745a2016-12-22 15:58:21 -050052struct PackedVarying;
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000053
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000054extern const char * const g_fakepath;
55
Jamie Madillf0d10f82015-03-31 12:56:52 -040056class InfoLog : angle::NonCopyable
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000057{
58 public:
59 InfoLog();
60 ~InfoLog();
61
Jamie Madill71c3b2c2015-05-07 11:49:20 -040062 size_t getLength() const;
Geoff Lange1a27752015-10-05 13:16:04 -040063 void getLog(GLsizei bufSize, GLsizei *length, char *infoLog) const;
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000064
65 void appendSanitized(const char *message);
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000066 void reset();
Jamie Madillf6113162015-05-07 11:49:21 -040067
68 // This helper class ensures we append a newline after writing a line.
69 class StreamHelper : angle::NonCopyable
70 {
71 public:
72 StreamHelper(StreamHelper &&rhs)
73 : mStream(rhs.mStream)
74 {
75 rhs.mStream = nullptr;
76 }
77
78 StreamHelper &operator=(StreamHelper &&rhs)
79 {
80 std::swap(mStream, rhs.mStream);
81 return *this;
82 }
83
84 ~StreamHelper()
85 {
86 // Write newline when destroyed on the stack
87 if (mStream)
88 {
89 (*mStream) << std::endl;
90 }
91 }
92
93 template <typename T>
94 StreamHelper &operator<<(const T &value)
95 {
96 (*mStream) << value;
97 return *this;
98 }
99
100 private:
101 friend class InfoLog;
102
103 StreamHelper(std::stringstream *stream)
104 : mStream(stream)
105 {
106 ASSERT(stream);
107 }
108
109 std::stringstream *mStream;
110 };
111
112 template <typename T>
113 StreamHelper operator<<(const T &value)
114 {
Jamie Madill23176ce2017-07-31 14:14:33 -0400115 ensureInitialized();
116 StreamHelper helper(mLazyStream.get());
Jamie Madillf6113162015-05-07 11:49:21 -0400117 helper << value;
118 return helper;
119 }
120
Jamie Madill23176ce2017-07-31 14:14:33 -0400121 std::string str() const { return mLazyStream ? mLazyStream->str() : ""; }
Jamie Madillf6113162015-05-07 11:49:21 -0400122
apatrick@chromium.org253b8d22012-06-22 19:27:21 +0000123 private:
Jamie Madill23176ce2017-07-31 14:14:33 -0400124 void ensureInitialized()
125 {
126 if (!mLazyStream)
127 {
128 mLazyStream.reset(new std::stringstream());
129 }
130 }
131
132 std::unique_ptr<std::stringstream> mLazyStream;
apatrick@chromium.org253b8d22012-06-22 19:27:21 +0000133};
134
Geoff Lang7dd2e102014-11-10 15:19:26 -0500135// Struct used for correlating uniforms/elements of uniform arrays to handles
136struct VariableLocation
137{
Jamie Madillfb997ec2017-09-20 15:44:27 -0400138 static constexpr unsigned int kUnused = GL_INVALID_INDEX;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500139
Jamie Madillfb997ec2017-09-20 15:44:27 -0400140 VariableLocation();
Olli Etuahoc8538042017-09-27 11:20:15 +0300141 VariableLocation(unsigned int arrayIndex, unsigned int index);
Geoff Langd8605522016-04-13 10:19:12 -0400142
Jamie Madillfe8b5982017-09-07 17:00:18 -0400143 // If used is false, it means this location is only used to fill an empty space in an array,
144 // and there is no corresponding uniform variable for this location. It can also mean the
145 // uniform was optimized out by the implementation.
Jamie Madillfb997ec2017-09-20 15:44:27 -0400146 bool used() const { return (index != kUnused); }
147 void markUnused() { index = kUnused; }
148 void markIgnored() { ignored = true; }
149
Olli Etuahoc8538042017-09-27 11:20:15 +0300150 bool areAllArrayIndicesZero() const;
151
152 // The "arrayIndices" vector stores indices for the GLSL array. "index" is an index of the
153 // location.
154 std::vector<unsigned int> arrayIndices; // Outermost array indices are in the back.
Jamie Madillfb997ec2017-09-20 15:44:27 -0400155 unsigned int index;
Geoff Langd8605522016-04-13 10:19:12 -0400156
Olli Etuahoc8538042017-09-27 11:20:15 +0300157 unsigned int flattenedArrayOffset; // For non-nested arrays this is the same as the array
158 // index. For arrays of arrays, the indices are converted to
159 // a single offset inside a one-dimensional array made up of
160 // the elements of the innermost arrays.
161
Geoff Langd8605522016-04-13 10:19:12 -0400162 // If this location was bound to an unreferenced uniform. Setting data on this uniform is a
163 // no-op.
164 bool ignored;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500165};
166
Sami Väisänen46eaa942016-06-29 10:26:37 +0300167// Information about a variable binding.
168// Currently used by CHROMIUM_path_rendering
169struct BindingInfo
170{
171 // The type of binding, for example GL_FLOAT_VEC3.
172 // This can be GL_NONE if the variable is optimized away.
173 GLenum type;
174
175 // This is the name of the variable in
176 // the translated shader program. Note that
177 // this can be empty in the case where the
178 // variable has been optimized away.
179 std::string name;
180
181 // True if the binding is valid, otherwise false.
182 bool valid;
183};
184
Jamie Madille7d84322017-01-10 18:21:59 -0500185// This small structure encapsulates binding sampler uniforms to active GL textures.
186struct SamplerBinding
187{
Jamie Madill54164b02017-08-28 15:17:37 -0400188 SamplerBinding(GLenum textureTypeIn, size_t elementCount, bool unreferenced)
189 : textureType(textureTypeIn), boundTextureUnits(elementCount, 0), unreferenced(unreferenced)
Jamie Madille7d84322017-01-10 18:21:59 -0500190 {
191 }
192
193 // Necessary for retrieving active textures from the GL state.
194 GLenum textureType;
195
196 // List of all textures bound to this sampler, of type textureType.
197 std::vector<GLuint> boundTextureUnits;
Jamie Madill54164b02017-08-28 15:17:37 -0400198
199 // A note if this sampler is an unreferenced uniform.
200 bool unreferenced;
Jamie Madille7d84322017-01-10 18:21:59 -0500201};
202
jchen10a9042d32017-03-17 08:50:45 +0800203// A varying with tranform feedback enabled. If it's an array, either the whole array or one of its
204// elements specified by 'arrayIndex' can set to be enabled.
205struct TransformFeedbackVarying : public sh::Varying
206{
207 TransformFeedbackVarying(const sh::Varying &varyingIn, GLuint index)
208 : sh::Varying(varyingIn), arrayIndex(index)
209 {
210 }
211 std::string nameWithArrayIndex() const
212 {
213 std::stringstream fullNameStr;
214 fullNameStr << name;
215 if (arrayIndex != GL_INVALID_INDEX)
216 {
217 fullNameStr << "[" << arrayIndex << "]";
218 }
219 return fullNameStr.str();
220 }
221 GLsizei size() const { return (arrayIndex == GL_INVALID_INDEX ? elementCount() : 1); }
222
223 GLuint arrayIndex;
224};
225
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800226struct ImageBinding
227{
Xinghua Cao0328b572017-06-26 15:51:36 +0800228 ImageBinding(size_t count) : boundImageUnits(count, 0) {}
229 ImageBinding(GLuint imageUnit, size_t count)
230 {
231 for (size_t index = 0; index < count; ++index)
232 {
233 boundImageUnits.push_back(imageUnit + static_cast<GLuint>(index));
234 }
235 }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800236
Xinghua Cao0328b572017-06-26 15:51:36 +0800237 std::vector<GLuint> boundImageUnits;
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800238};
239
Jamie Madill48ef11b2016-04-27 15:21:52 -0400240class ProgramState final : angle::NonCopyable
241{
242 public:
243 ProgramState();
244 ~ProgramState();
245
246 const std::string &getLabel();
247
Jamie Madillbd044ed2017-06-05 12:59:21 -0400248 Shader *getAttachedVertexShader() const { return mAttachedVertexShader; }
249 Shader *getAttachedFragmentShader() const { return mAttachedFragmentShader; }
250 Shader *getAttachedComputeShader() const { return mAttachedComputeShader; }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400251 const std::vector<std::string> &getTransformFeedbackVaryingNames() const
252 {
253 return mTransformFeedbackVaryingNames;
254 }
255 GLint getTransformFeedbackBufferMode() const { return mTransformFeedbackBufferMode; }
256 GLuint getUniformBlockBinding(GLuint uniformBlockIndex) const
257 {
jchen107a20b972017-06-13 14:25:26 +0800258 ASSERT(uniformBlockIndex < mUniformBlocks.size());
259 return mUniformBlocks[uniformBlockIndex].binding;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400260 }
Jiajia Qin729b2c62017-08-14 09:36:11 +0800261 GLuint getShaderStorageBlockBinding(GLuint blockIndex) const
262 {
263 ASSERT(blockIndex < mShaderStorageBlocks.size());
264 return mShaderStorageBlocks[blockIndex].binding;
265 }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400266 const UniformBlockBindingMask &getActiveUniformBlockBindingsMask() const
267 {
268 return mActiveUniformBlockBindings;
269 }
270 const std::vector<sh::Attribute> &getAttributes() const { return mAttributes; }
271 const AttributesMask &getActiveAttribLocationsMask() const
272 {
273 return mActiveAttribLocationsMask;
274 }
Jamie Madillbd159f02017-10-09 19:39:06 -0400275 unsigned int getMaxActiveAttribLocation() const { return mMaxActiveAttribLocation; }
Corentin Walleze7557742017-06-01 13:09:57 -0400276 DrawBufferMask getActiveOutputVariables() const { return mActiveOutputVariables; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400277 const std::vector<sh::OutputVariable> &getOutputVariables() const { return mOutputVariables; }
jchen1015015f72017-03-16 13:54:21 +0800278 const std::map<int, VariableLocation> &getOutputLocations() const { return mOutputLocations; }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400279 const std::vector<LinkedUniform> &getUniforms() const { return mUniforms; }
280 const std::vector<VariableLocation> &getUniformLocations() const { return mUniformLocations; }
Jiajia Qin729b2c62017-08-14 09:36:11 +0800281 const std::vector<InterfaceBlock> &getUniformBlocks() const { return mUniformBlocks; }
282 const std::vector<InterfaceBlock> &getShaderStorageBlocks() const
283 {
284 return mShaderStorageBlocks;
285 }
Jamie Madille7d84322017-01-10 18:21:59 -0500286 const std::vector<SamplerBinding> &getSamplerBindings() const { return mSamplerBindings; }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800287 const std::vector<ImageBinding> &getImageBindings() const { return mImageBindings; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400288 const sh::WorkGroupSize &getComputeShaderLocalSize() const { return mComputeShaderLocalSize; }
289 const RangeUI &getSamplerUniformRange() const { return mSamplerUniformRange; }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800290 const RangeUI &getImageUniformRange() const { return mImageUniformRange; }
jchen10eaef1e52017-06-13 10:44:11 +0800291 const RangeUI &getAtomicCounterUniformRange() const { return mAtomicCounterUniformRange; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400292
Jamie Madill4f86d052017-06-05 12:59:26 -0400293 const std::vector<TransformFeedbackVarying> &getLinkedTransformFeedbackVaryings() const
294 {
295 return mLinkedTransformFeedbackVaryings;
296 }
jchen10eaef1e52017-06-13 10:44:11 +0800297 const std::vector<AtomicCounterBuffer> &getAtomicCounterBuffers() const
298 {
299 return mAtomicCounterBuffers;
300 }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400301
Jamie Madill48ef11b2016-04-27 15:21:52 -0400302 GLint getUniformLocation(const std::string &name) const;
Jamie Madille7d84322017-01-10 18:21:59 -0500303 GLuint getUniformIndexFromName(const std::string &name) const;
304 GLuint getUniformIndexFromLocation(GLint location) const;
305 Optional<GLuint> getSamplerIndex(GLint location) const;
306 bool isSamplerUniformIndex(GLuint index) const;
307 GLuint getSamplerIndexFromUniformIndex(GLuint uniformIndex) const;
Jamie Madill34ca4f52017-06-13 11:49:39 -0400308 GLuint getAttributeLocation(const std::string &name) const;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400309
Martin Radev4e619f52017-08-09 11:50:06 +0300310 int getNumViews() const { return mNumViews; }
311 bool usesMultiview() const { return mNumViews != -1; }
312
Jamie Madill48ef11b2016-04-27 15:21:52 -0400313 private:
Jamie Madill4f86d052017-06-05 12:59:26 -0400314 friend class MemoryProgramCache;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400315 friend class Program;
316
317 std::string mLabel;
318
Martin Radev4c4c8e72016-08-04 12:25:34 +0300319 sh::WorkGroupSize mComputeShaderLocalSize;
320
Jamie Madill48ef11b2016-04-27 15:21:52 -0400321 Shader *mAttachedFragmentShader;
322 Shader *mAttachedVertexShader;
Martin Radev4c4c8e72016-08-04 12:25:34 +0300323 Shader *mAttachedComputeShader;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400324
325 std::vector<std::string> mTransformFeedbackVaryingNames;
jchen10a9042d32017-03-17 08:50:45 +0800326 std::vector<TransformFeedbackVarying> mLinkedTransformFeedbackVaryings;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400327 GLenum mTransformFeedbackBufferMode;
328
jchen107a20b972017-06-13 14:25:26 +0800329 // For faster iteration on the blocks currently being bound.
Jamie Madill48ef11b2016-04-27 15:21:52 -0400330 UniformBlockBindingMask mActiveUniformBlockBindings;
331
332 std::vector<sh::Attribute> mAttributes;
Jamie Madill6de51852017-04-12 09:53:01 -0400333 angle::BitSet<MAX_VERTEX_ATTRIBS> mActiveAttribLocationsMask;
Jamie Madillbd159f02017-10-09 19:39:06 -0400334 unsigned int mMaxActiveAttribLocation;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400335
336 // Uniforms are sorted in order:
jchen10eaef1e52017-06-13 10:44:11 +0800337 // 1. Non-opaque uniforms
Jamie Madill48ef11b2016-04-27 15:21:52 -0400338 // 2. Sampler uniforms
jchen10eaef1e52017-06-13 10:44:11 +0800339 // 3. Image uniforms
340 // 4. Atomic counter uniforms
341 // 5. Uniform block uniforms
342 // This makes opaque uniform validation easier, since we don't need a separate list.
Jamie Madill48ef11b2016-04-27 15:21:52 -0400343 std::vector<LinkedUniform> mUniforms;
344 std::vector<VariableLocation> mUniformLocations;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800345 std::vector<InterfaceBlock> mUniformBlocks;
346 std::vector<InterfaceBlock> mShaderStorageBlocks;
jchen10eaef1e52017-06-13 10:44:11 +0800347 std::vector<AtomicCounterBuffer> mAtomicCounterBuffers;
Jamie Madille7d84322017-01-10 18:21:59 -0500348 RangeUI mSamplerUniformRange;
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800349 RangeUI mImageUniformRange;
jchen10eaef1e52017-06-13 10:44:11 +0800350 RangeUI mAtomicCounterUniformRange;
Jamie Madille7d84322017-01-10 18:21:59 -0500351
352 // An array of the samplers that are used by the program
353 std::vector<gl::SamplerBinding> mSamplerBindings;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400354
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800355 // An array of the images that are used by the program
356 std::vector<gl::ImageBinding> mImageBindings;
357
jchen1015015f72017-03-16 13:54:21 +0800358 std::vector<sh::OutputVariable> mOutputVariables;
jchen1015015f72017-03-16 13:54:21 +0800359 std::map<int, VariableLocation> mOutputLocations;
Corentin Walleze7557742017-06-01 13:09:57 -0400360 DrawBufferMask mActiveOutputVariables;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400361
Geoff Lange0cff192017-05-30 13:04:56 -0400362 // Fragment output variable base types: FLOAT, INT, or UINT. Ordered by location.
363 std::vector<GLenum> mOutputVariableTypes;
364
Jamie Madill48ef11b2016-04-27 15:21:52 -0400365 bool mBinaryRetrieveableHint;
Yunchao He61afff12017-03-14 15:34:03 +0800366 bool mSeparable;
Martin Radev7cf61662017-07-26 17:10:53 +0300367
368 // ANGLE_multiview.
369 int mNumViews;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400370};
371
Geoff Lang70d0f492015-12-10 17:45:46 -0500372class Program final : angle::NonCopyable, public LabeledObject
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000373{
374 public:
Geoff Lang4ddf5af2016-12-01 14:30:44 -0500375 Program(rx::GLImplFactory *factory, ShaderProgramManager *manager, GLuint handle);
Jamie Madill4928b7c2017-06-20 12:57:39 -0400376 void onDestroy(const Context *context);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000377
Geoff Lang7dd2e102014-11-10 15:19:26 -0500378 GLuint id() const { return mHandle; }
379
Geoff Lang70d0f492015-12-10 17:45:46 -0500380 void setLabel(const std::string &label) override;
381 const std::string &getLabel() const override;
382
Geoff Lang47110bf2016-04-20 11:13:22 -0700383 rx::ProgramImpl *getImplementation() const { return mProgram; }
Geoff Lang7dd2e102014-11-10 15:19:26 -0500384
Jamie Madillef300b12016-10-07 15:12:09 -0400385 void attachShader(Shader *shader);
Jamie Madillc1d770e2017-04-13 17:31:24 -0400386 void detachShader(const Context *context, Shader *shader);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000387 int getAttachedShadersCount() const;
388
Jamie Madillef300b12016-10-07 15:12:09 -0400389 const Shader *getAttachedVertexShader() const { return mState.mAttachedVertexShader; }
390 const Shader *getAttachedFragmentShader() const { return mState.mAttachedFragmentShader; }
391 const Shader *getAttachedComputeShader() const { return mState.mAttachedComputeShader; }
392
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000393 void bindAttributeLocation(GLuint index, const char *name);
Geoff Langd8605522016-04-13 10:19:12 -0400394 void bindUniformLocation(GLuint index, const char *name);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000395
Sami Väisänen46eaa942016-06-29 10:26:37 +0300396 // CHROMIUM_path_rendering
Jamie Madillbd044ed2017-06-05 12:59:21 -0400397 BindingInfo getFragmentInputBindingInfo(const Context *context, GLint index) const;
Sami Väisänen46eaa942016-06-29 10:26:37 +0300398 void bindFragmentInputLocation(GLint index, const char *name);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400399 void pathFragmentInputGen(const Context *context,
400 GLint index,
Sami Väisänen46eaa942016-06-29 10:26:37 +0300401 GLenum genMode,
402 GLint components,
403 const GLfloat *coeffs);
404
Jamie Madill8ecf7f92017-01-13 17:29:52 -0500405 Error link(const gl::Context *context);
Geoff Lange1a27752015-10-05 13:16:04 -0400406 bool isLinked() const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500407
Jamie Madilla2c74982016-12-12 11:20:42 -0500408 Error loadBinary(const Context *context,
409 GLenum binaryFormat,
410 const void *binary,
411 GLsizei length);
412 Error saveBinary(const Context *context,
413 GLenum *binaryFormat,
414 void *binary,
415 GLsizei bufSize,
416 GLsizei *length) const;
Jamie Madillffe00c02017-06-27 16:26:55 -0400417 GLint getBinaryLength(const Context *context) const;
Geoff Langc5629752015-12-07 16:29:04 -0500418 void setBinaryRetrievableHint(bool retrievable);
419 bool getBinaryRetrievableHint() const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000420
Yunchao He61afff12017-03-14 15:34:03 +0800421 void setSeparable(bool separable);
422 bool isSeparable() const;
423
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000424 int getInfoLogLength() const;
Geoff Lange1a27752015-10-05 13:16:04 -0400425 void getInfoLog(GLsizei bufSize, GLsizei *length, char *infoLog) const;
426 void getAttachedShaders(GLsizei maxCount, GLsizei *count, GLuint *shaders) const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000427
Geoff Lange1a27752015-10-05 13:16:04 -0400428 GLuint getAttributeLocation(const std::string &name) const;
Jamie Madill63805b42015-08-25 13:17:39 -0400429 bool isAttribLocationActive(size_t attribLocation) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500430
jchen10fd7c3b52017-03-21 15:36:03 +0800431 void getActiveAttribute(GLuint index,
432 GLsizei bufsize,
433 GLsizei *length,
434 GLint *size,
435 GLenum *type,
436 GLchar *name) const;
Geoff Lange1a27752015-10-05 13:16:04 -0400437 GLint getActiveAttributeCount() const;
438 GLint getActiveAttributeMaxLength() const;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400439 const std::vector<sh::Attribute> &getAttributes() const { return mState.mAttributes; }
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000440
Geoff Lang7dd2e102014-11-10 15:19:26 -0500441 GLint getFragDataLocation(const std::string &name) const;
jchen10fd7c3b52017-03-21 15:36:03 +0800442 size_t getOutputResourceCount() const;
Geoff Lange0cff192017-05-30 13:04:56 -0400443 const std::vector<GLenum> &getOutputVariableTypes() const
444 {
445 return mState.mOutputVariableTypes;
446 }
Corentin Wallezdb9e5d32017-06-12 12:05:45 -0700447 DrawBufferMask getActiveOutputVariables() const { return mState.mActiveOutputVariables; }
Geoff Lang7dd2e102014-11-10 15:19:26 -0500448
Geoff Lange1a27752015-10-05 13:16:04 -0400449 void getActiveUniform(GLuint index,
450 GLsizei bufsize,
451 GLsizei *length,
452 GLint *size,
453 GLenum *type,
454 GLchar *name) const;
455 GLint getActiveUniformCount() const;
456 GLint getActiveUniformMaxLength() const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500457 bool isValidUniformLocation(GLint location) const;
Jamie Madill62d31cb2015-09-11 13:25:51 -0400458 const LinkedUniform &getUniformByLocation(GLint location) const;
Jamie Madillac4e9c32017-01-13 14:07:12 -0500459 const VariableLocation &getUniformLocation(GLint location) const;
460 const std::vector<VariableLocation> &getUniformLocations() const;
461 const LinkedUniform &getUniformByIndex(GLuint index) const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000462
Jamie Madill81c2e252017-09-09 23:32:46 -0400463 enum SetUniformResult
464 {
465 SamplerChanged,
466 NoSamplerChange,
467 };
468
Jamie Madill62d31cb2015-09-11 13:25:51 -0400469 GLint getUniformLocation(const std::string &name) const;
470 GLuint getUniformIndex(const std::string &name) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500471 void setUniform1fv(GLint location, GLsizei count, const GLfloat *v);
472 void setUniform2fv(GLint location, GLsizei count, const GLfloat *v);
473 void setUniform3fv(GLint location, GLsizei count, const GLfloat *v);
474 void setUniform4fv(GLint location, GLsizei count, const GLfloat *v);
Jamie Madill81c2e252017-09-09 23:32:46 -0400475 SetUniformResult setUniform1iv(GLint location, GLsizei count, const GLint *v);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500476 void setUniform2iv(GLint location, GLsizei count, const GLint *v);
477 void setUniform3iv(GLint location, GLsizei count, const GLint *v);
478 void setUniform4iv(GLint location, GLsizei count, const GLint *v);
479 void setUniform1uiv(GLint location, GLsizei count, const GLuint *v);
480 void setUniform2uiv(GLint location, GLsizei count, const GLuint *v);
481 void setUniform3uiv(GLint location, GLsizei count, const GLuint *v);
482 void setUniform4uiv(GLint location, GLsizei count, const GLuint *v);
483 void setUniformMatrix2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
484 void setUniformMatrix3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
485 void setUniformMatrix4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
486 void setUniformMatrix2x3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
487 void setUniformMatrix3x2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
488 void setUniformMatrix2x4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
489 void setUniformMatrix4x2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
490 void setUniformMatrix3x4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
491 void setUniformMatrix4x3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
492
Jamie Madill54164b02017-08-28 15:17:37 -0400493 void getUniformfv(const Context *context, GLint location, GLfloat *params) const;
494 void getUniformiv(const Context *context, GLint location, GLint *params) const;
495 void getUniformuiv(const Context *context, GLint location, GLuint *params) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500496
Geoff Lang7dd2e102014-11-10 15:19:26 -0500497 void getActiveUniformBlockName(GLuint uniformBlockIndex, GLsizei bufSize, GLsizei *length, GLchar *uniformBlockName) const;
Geoff Lange1a27752015-10-05 13:16:04 -0400498 GLuint getActiveUniformBlockCount() const;
jchen1058f67be2017-10-27 08:59:27 +0800499 GLuint getActiveAtomicCounterBufferCount() const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800500 GLuint getActiveShaderStorageBlockCount() const;
Geoff Lange1a27752015-10-05 13:16:04 -0400501 GLint getActiveUniformBlockMaxLength() const;
shannonwoods@chromium.orge684b582013-05-30 00:07:42 +0000502
Geoff Lange1a27752015-10-05 13:16:04 -0400503 GLuint getUniformBlockIndex(const std::string &name) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500504
shannonwoods@chromium.org70eb1ea2013-05-30 00:07:20 +0000505 void bindUniformBlock(GLuint uniformBlockIndex, GLuint uniformBlockBinding);
506 GLuint getUniformBlockBinding(GLuint uniformBlockIndex) const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800507 GLuint getShaderStorageBlockBinding(GLuint shaderStorageBlockIndex) const;
shannonwoods@chromium.org70eb1ea2013-05-30 00:07:20 +0000508
Jiajia Qin729b2c62017-08-14 09:36:11 +0800509 const InterfaceBlock &getUniformBlockByIndex(GLuint index) const;
Gregoire Payen de La Garanderie68694e92015-03-24 14:03:37 +0000510
Geoff Lang48dcae72014-02-05 16:28:24 -0500511 void setTransformFeedbackVaryings(GLsizei count, const GLchar *const *varyings, GLenum bufferMode);
512 void getTransformFeedbackVarying(GLuint index, GLsizei bufSize, GLsizei *length, GLsizei *size, GLenum *type, GLchar *name) const;
Geoff Lang1b6edcb2014-02-03 14:27:56 -0500513 GLsizei getTransformFeedbackVaryingCount() const;
514 GLsizei getTransformFeedbackVaryingMaxLength() const;
515 GLenum getTransformFeedbackBufferMode() const;
516
Frank Henigmanfccbac22017-05-28 17:29:26 -0400517 static bool linkValidateInterfaceBlockFields(InfoLog &infoLog,
518 const std::string &uniformName,
519 const sh::InterfaceBlockField &vertexUniform,
520 const sh::InterfaceBlockField &fragmentUniform,
521 bool webglCompatibility);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500522
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000523 void addRef();
Jamie Madill6c1f6712017-02-14 19:08:04 -0500524 void release(const Context *context);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000525 unsigned int getRefCount() const;
526 void flagForDeletion();
527 bool isFlaggedForDeletion() const;
528
Brandon Jones43a53e22014-08-28 16:23:22 -0700529 void validate(const Caps &caps);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500530 bool validateSamplers(InfoLog *infoLog, const Caps &caps);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000531 bool isValidated() const;
Jamie Madilla4595b82017-01-11 17:36:34 -0500532 bool samplesFromTexture(const gl::State &state, GLuint textureID) const;
apatrick@chromium.org90080e32012-07-09 22:15:33 +0000533
Jamie Madill63805b42015-08-25 13:17:39 -0400534 const AttributesMask &getActiveAttribLocationsMask() const
535 {
Jamie Madill48ef11b2016-04-27 15:21:52 -0400536 return mState.mActiveAttribLocationsMask;
Jamie Madill63805b42015-08-25 13:17:39 -0400537 }
538
Jamie Madille7d84322017-01-10 18:21:59 -0500539 const std::vector<SamplerBinding> &getSamplerBindings() const
540 {
541 return mState.mSamplerBindings;
542 }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800543
544 const std::vector<ImageBinding> &getImageBindings() const { return mState.mImageBindings; }
Xinghua Cao971f8502017-10-17 13:01:24 +0800545 const sh::WorkGroupSize &getComputeShaderLocalSize() const
546 {
547 return mState.mComputeShaderLocalSize;
548 }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800549
Jamie Madilldf68a6f2017-01-13 17:29:53 -0500550 const ProgramState &getState() const { return mState; }
Jamie Madille7d84322017-01-10 18:21:59 -0500551
Olli Etuahob78707c2017-03-09 15:03:11 +0000552 static bool linkValidateVariablesBase(InfoLog &infoLog,
553 const std::string &variableName,
554 const sh::ShaderVariable &vertexVariable,
555 const sh::ShaderVariable &fragmentVariable,
556 bool validatePrecision);
557
jchen1015015f72017-03-16 13:54:21 +0800558 GLuint getInputResourceIndex(const GLchar *name) const;
559 GLuint getOutputResourceIndex(const GLchar *name) const;
jchen10fd7c3b52017-03-21 15:36:03 +0800560 void getInputResourceName(GLuint index, GLsizei bufSize, GLsizei *length, GLchar *name) const;
561 void getOutputResourceName(GLuint index, GLsizei bufSize, GLsizei *length, GLchar *name) const;
jchen10baf5d942017-08-28 20:45:48 +0800562 void getUniformResourceName(GLuint index, GLsizei bufSize, GLsizei *length, GLchar *name) const;
jchen10880683b2017-04-12 16:21:55 +0800563 const sh::Attribute &getInputResource(GLuint index) const;
564 const sh::OutputVariable &getOutputResource(GLuint index) const;
jchen1015015f72017-03-16 13:54:21 +0800565
Geoff Langd8605522016-04-13 10:19:12 -0400566 class Bindings final : angle::NonCopyable
567 {
568 public:
569 void bindLocation(GLuint index, const std::string &name);
570 int getBinding(const std::string &name) const;
571
572 typedef std::unordered_map<std::string, GLuint>::const_iterator const_iterator;
573 const_iterator begin() const;
574 const_iterator end() const;
575
576 private:
577 std::unordered_map<std::string, GLuint> mBindings;
578 };
579
Jamie Madill32447362017-06-28 14:53:52 -0400580 const Bindings &getAttributeBindings() const { return mAttributeBindings; }
581 const Bindings &getUniformLocationBindings() const { return mUniformLocationBindings; }
582 const Bindings &getFragmentInputBindings() const { return mFragmentInputBindings; }
583
Martin Radev4e619f52017-08-09 11:50:06 +0300584 int getNumViews() const { return mState.getNumViews(); }
585 bool usesMultiview() const { return mState.usesMultiview(); }
Martin Radev7cf61662017-07-26 17:10:53 +0300586
Olli Etuahob78707c2017-03-09 15:03:11 +0000587 private:
Jamie Madill4928b7c2017-06-20 12:57:39 -0400588 ~Program();
589
Jamie Madill192745a2016-12-22 15:58:21 -0500590 struct VaryingRef
591 {
592 const sh::Varying *get() const { return vertex ? vertex : fragment; }
593
594 const sh::Varying *vertex = nullptr;
595 const sh::Varying *fragment = nullptr;
596 };
597
598 using MergedVaryings = std::map<std::string, VaryingRef>;
599
Jamie Madill6c1f6712017-02-14 19:08:04 -0500600 void unlink();
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000601
Jamie Madillbd044ed2017-06-05 12:59:21 -0400602 bool linkAttributes(const Context *context, InfoLog &infoLog);
Martin Radev4c4c8e72016-08-04 12:25:34 +0300603 bool validateVertexAndFragmentInterfaceBlocks(
604 const std::vector<sh::InterfaceBlock> &vertexInterfaceBlocks,
605 const std::vector<sh::InterfaceBlock> &fragmentInterfaceBlocks,
Frank Henigmanfccbac22017-05-28 17:29:26 -0400606 InfoLog &infoLog,
607 bool webglCompatibility) const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800608 bool linkInterfaceBlocks(const Context *context, InfoLog &infoLog);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400609 bool linkVaryings(const Context *context, InfoLog &infoLog) const;
Olli Etuaho6ca2b652017-02-19 18:05:10 +0000610
Jamie Madillbd044ed2017-06-05 12:59:21 -0400611 bool linkUniforms(const Context *context,
612 InfoLog &infoLog,
613 const Bindings &uniformLocationBindings);
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800614 void linkSamplerAndImageBindings();
jchen10eaef1e52017-06-13 10:44:11 +0800615 bool linkAtomicCounterBuffers();
Olli Etuaho6ca2b652017-02-19 18:05:10 +0000616
Jamie Madilla2c74982016-12-12 11:20:42 -0500617 bool areMatchingInterfaceBlocks(InfoLog &infoLog,
Martin Radev4c4c8e72016-08-04 12:25:34 +0300618 const sh::InterfaceBlock &vertexInterfaceBlock,
Frank Henigmanfccbac22017-05-28 17:29:26 -0400619 const sh::InterfaceBlock &fragmentInterfaceBlock,
620 bool webglCompatibility) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500621
Yuly Novikova1f6dc92016-06-15 23:27:04 -0400622 static bool linkValidateVaryings(InfoLog &infoLog,
623 const std::string &varyingName,
624 const sh::Varying &vertexVarying,
625 const sh::Varying &fragmentVarying,
626 int shaderVersion);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400627 bool linkValidateBuiltInVaryings(const Context *context, InfoLog &infoLog) const;
jchen10a9042d32017-03-17 08:50:45 +0800628 bool linkValidateTransformFeedback(const gl::Context *context,
629 InfoLog &infoLog,
Jamie Madill192745a2016-12-22 15:58:21 -0500630 const MergedVaryings &linkedVaryings,
Jamie Madillccdf74b2015-08-18 10:46:12 -0400631 const Caps &caps) const;
Yuly Novikovcaa5cda2017-06-15 21:14:03 -0400632 bool linkValidateGlobalNames(const Context *context, InfoLog &infoLog) const;
Jamie Madillccdf74b2015-08-18 10:46:12 -0400633
Jamie Madill192745a2016-12-22 15:58:21 -0500634 void gatherTransformFeedbackVaryings(const MergedVaryings &varyings);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500635
Jamie Madillbd044ed2017-06-05 12:59:21 -0400636 MergedVaryings getMergedVaryings(const Context *context) const;
Jamie Madill192745a2016-12-22 15:58:21 -0500637 std::vector<PackedVarying> getPackedVaryings(const MergedVaryings &mergedVaryings) const;
Jamie Madillbd044ed2017-06-05 12:59:21 -0400638 void linkOutputVariables(const Context *context);
Jamie Madillccdf74b2015-08-18 10:46:12 -0400639
Olli Etuaho48fed632017-03-16 12:05:30 +0000640 void setUniformValuesFromBindingQualifiers();
641
jchen10eaef1e52017-06-13 10:44:11 +0800642 void gatherAtomicCounterBuffers();
Jiajia Qin729b2c62017-08-14 09:36:11 +0800643 void gatherComputeBlockInfo(const std::vector<sh::InterfaceBlock> &computeBlocks);
644 void gatherVertexAndFragmentBlockInfo(
645 const std::vector<sh::InterfaceBlock> &vertexInterfaceBlocks,
646 const std::vector<sh::InterfaceBlock> &fragmentInterfaceBlocks);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400647 void gatherInterfaceBlockInfo(const Context *context);
Jamie Madill4a3c2342015-10-08 12:58:45 -0400648 template <typename VarT>
649 void defineUniformBlockMembers(const std::vector<VarT> &fields,
650 const std::string &prefix,
Olli Etuaho855d9642017-05-17 14:05:06 +0300651 const std::string &mappedPrefix,
Jamie Madill4a3c2342015-10-08 12:58:45 -0400652 int blockIndex);
653
Jiajia Qin729b2c62017-08-14 09:36:11 +0800654 void defineInterfaceBlock(const sh::InterfaceBlock &interfaceBlock, GLenum shaderType);
Jamie Madill62d31cb2015-09-11 13:25:51 -0400655
Corentin Wallez8b7d8142016-11-15 13:40:37 -0500656 // Both these function update the cached uniform values and return a modified "count"
657 // so that the uniform update doesn't overflow the uniform.
Jamie Madill62d31cb2015-09-11 13:25:51 -0400658 template <typename T>
Jamie Madillbe5e2ec2017-08-31 13:28:28 -0400659 GLsizei clampUniformCount(const VariableLocation &locationInfo,
660 GLsizei count,
661 int vectorSize,
Jamie Madille7d84322017-01-10 18:21:59 -0500662 const T *v);
Jamie Madillbe5e2ec2017-08-31 13:28:28 -0400663 template <size_t cols, size_t rows, typename T>
664 GLsizei clampMatrixUniformCount(GLint location, GLsizei count, GLboolean transpose, const T *v);
665
666 void updateSamplerUniform(const VariableLocation &locationInfo,
667 GLsizei clampedCount,
668 const GLint *v);
Jamie Madill62d31cb2015-09-11 13:25:51 -0400669
670 template <typename DestT>
Jamie Madill54164b02017-08-28 15:17:37 -0400671 void getUniformInternal(const Context *context,
672 DestT *dataOut,
673 GLint location,
674 GLenum nativeType,
675 int components) const;
Jamie Madill62d31cb2015-09-11 13:25:51 -0400676
jchen10baf5d942017-08-28 20:45:48 +0800677 template <typename T>
678 void getResourceName(GLuint index,
679 const std::vector<T> &resources,
680 GLsizei bufSize,
681 GLsizei *length,
682 GLchar *name) const;
683
Jamie Madill48ef11b2016-04-27 15:21:52 -0400684 ProgramState mState;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500685 rx::ProgramImpl *mProgram;
686
Geoff Lang7dd2e102014-11-10 15:19:26 -0500687 bool mValidated;
688
Geoff Langd8605522016-04-13 10:19:12 -0400689 Bindings mAttributeBindings;
Olli Etuaho4a92ceb2017-02-19 17:51:24 +0000690
691 // Note that this has nothing to do with binding layout qualifiers that can be set for some
692 // uniforms in GLES3.1+. It is used to pre-set the location of uniforms.
693 Bindings mUniformLocationBindings;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000694
Sami Väisänen46eaa942016-06-29 10:26:37 +0300695 // CHROMIUM_path_rendering
696 Bindings mFragmentInputBindings;
697
daniel@transgaming.com716056c2012-07-24 18:38:59 +0000698 bool mLinked;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000699 bool mDeleteStatus; // Flag to indicate that the program can be deleted when no longer in use
daniel@transgaming.com4fa08332010-05-11 02:29:27 +0000700
daniel@transgaming.comda13f3e2010-07-28 19:20:56 +0000701 unsigned int mRefCount;
702
Geoff Lang4ddf5af2016-12-01 14:30:44 -0500703 ShaderProgramManager *mResourceManager;
daniel@transgaming.comda13f3e2010-07-28 19:20:56 +0000704 const GLuint mHandle;
apatrick@chromium.org253b8d22012-06-22 19:27:21 +0000705
706 InfoLog mInfoLog;
Jamie Madill3d3d2f22015-09-23 16:47:51 -0400707
708 // Cache for sampler validation
709 Optional<bool> mCachedValidateSamplersResult;
710 std::vector<GLenum> mTextureUnitTypesCache;
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000711};
Jamie Madilla2c74982016-12-12 11:20:42 -0500712} // namespace gl
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000713
Geoff Lang0a73dd82014-11-19 16:18:08 -0500714#endif // LIBANGLE_PROGRAM_H_