kc3-lang/angle/src/libANGLE/FrameCapture.h

• Show log

  Commit

• Hash : 14a2983f
  Author :
  Date : 2020-02-20T17:14:02
  

  Trace/Replay: Add uniform locations map.
  
  This portability feature allows a single T-Rex capture done on Vulkan
  to work seamlessly on the ANGLE GL back-end and the WGL-loaded NVIDIA
  OpenGL driver.
  
  Previously the uniform locations would not be consistent between ANGLE
  and a native driver. And incompatiblities would trigger error messages
  between ANGLE back-ends.
  
  Will allow us to compare ANGLE performance vs the native driver using a
  capture.
  
  Example captured calls:
  
      glLinkProgram(gShaderProgramMap[3]);
      UpdateUniformLocation(gShaderProgramMap[3], "s_texture", 0);
  
  Bug: angleproject:4411
  Change-Id: I5ddc76d75e15a9291b351e2aab94af4881f6ef47
  Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/2068121
  Commit-Queue: Jamie Madill <jmadill@chromium.org>
  Reviewed-by: Cody Northrop <cnorthrop@google.com>
  

Download

• src/libANGLE/FrameCapture.h

• 
  // Copyright 2019 The ANGLE Project Authors. All rights reserved.
  // Use of this source code is governed by a BSD-style license that can be
  // found in the LICENSE file.
  //
  // FrameCapture.h:
  //   ANGLE Frame capture inteface.
  //
  
  #ifndef LIBANGLE_FRAME_CAPTURE_H_
  #define LIBANGLE_FRAME_CAPTURE_H_
  
  #include "common/PackedEnums.h"
  #include "libANGLE/Context.h"
  #include "libANGLE/angletypes.h"
  #include "libANGLE/entry_points_utils.h"
  #include "libANGLE/frame_capture_utils_autogen.h"
  
  namespace gl
  {
  enum class GLenumGroup;
  }
  
  namespace angle
  {
  struct ParamCapture : angle::NonCopyable
  {
      ParamCapture();
      ParamCapture(const char *nameIn, ParamType typeIn);
      ~ParamCapture();
  
      ParamCapture(ParamCapture &&other);
      ParamCapture &operator=(ParamCapture &&other);
  
      std::string name;
      ParamType type;
      ParamValue value;
      gl::GLenumGroup enumGroup;  // only used for param type GLenum, GLboolean and GLbitfield
      std::vector<std::vector<uint8_t>> data;
      int arrayClientPointerIndex = -1;
      size_t readBufferSizeBytes  = 0;
  };
  
  class ParamBuffer final : angle::NonCopyable
  {
    public:
      ParamBuffer();
      ~ParamBuffer();
  
      ParamBuffer(ParamBuffer &&other);
      ParamBuffer &operator=(ParamBuffer &&other);
  
      template <typename T>
      void addValueParam(const char *paramName, ParamType paramType, T paramValue);
      template <typename T>
      void addEnumParam(const char *paramName,
                        gl::GLenumGroup enumGroup,
                        ParamType paramType,
                        T paramValue);
  
      ParamCapture &getParam(const char *paramName, ParamType paramType, int index);
      const ParamCapture &getParam(const char *paramName, ParamType paramType, int index) const;
      ParamCapture &getParamFlexName(const char *paramName1,
                                     const char *paramName2,
                                     ParamType paramType,
                                     int index);
      const ParamCapture &getParamFlexName(const char *paramName1,
                                           const char *paramName2,
                                           ParamType paramType,
                                           int index) const;
      const ParamCapture &getReturnValue() const { return mReturnValueCapture; }
  
      void addParam(ParamCapture &&param);
      void addReturnValue(ParamCapture &&returnValue);
      bool hasClientArrayData() const { return mClientArrayDataParam != -1; }
      ParamCapture &getClientArrayPointerParameter();
      size_t getReadBufferSize() const { return mReadBufferSize; }
  
      const std::vector<ParamCapture> &getParamCaptures() const { return mParamCaptures; }
  
    private:
      std::vector<ParamCapture> mParamCaptures;
      ParamCapture mReturnValueCapture;
      int mClientArrayDataParam = -1;
      size_t mReadBufferSize    = 0;
  };
  
  struct CallCapture
  {
      CallCapture(gl::EntryPoint entryPointIn, ParamBuffer &&paramsIn);
      CallCapture(const std::string &customFunctionNameIn, ParamBuffer &&paramsIn);
      ~CallCapture();
  
      CallCapture(CallCapture &&other);
      CallCapture &operator=(CallCapture &&other);
  
      const char *name() const;
  
      gl::EntryPoint entryPoint;
      std::string customFunctionName;
      ParamBuffer params;
  };
  
  class ReplayContext
  {
    public:
      ReplayContext(size_t readBufferSizebytes, const gl::AttribArray<size_t> &clientArraysSizebytes);
      ~ReplayContext();
  
      template <typename T>
      T getReadBufferPointer(const ParamCapture &param)
      {
          ASSERT(param.readBufferSizeBytes > 0);
          ASSERT(mReadBuffer.size() >= param.readBufferSizeBytes);
          return reinterpret_cast<T>(mReadBuffer.data());
      }
      template <typename T>
      T getAsConstPointer(const ParamCapture &param)
      {
          if (param.arrayClientPointerIndex != -1)
          {
              return reinterpret_cast<T>(mClientArraysBuffer[param.arrayClientPointerIndex].data());
          }
  
          if (!param.data.empty())
          {
              ASSERT(param.data.size() == 1);
              return reinterpret_cast<T>(param.data[0].data());
          }
  
          return nullptr;
      }
  
      template <typename T>
      T getAsPointerConstPointer(const ParamCapture &param)
      {
          static_assert(sizeof(typename std::remove_pointer<T>::type) == sizeof(uint8_t *),
                        "pointer size not match!");
  
          ASSERT(!param.data.empty());
          mPointersBuffer.clear();
          mPointersBuffer.reserve(param.data.size());
          for (const std::vector<uint8_t> &data : param.data)
          {
              mPointersBuffer.emplace_back(data.data());
          }
          return reinterpret_cast<T>(mPointersBuffer.data());
      }
  
      gl::AttribArray<std::vector<uint8_t>> &getClientArraysBuffer() { return mClientArraysBuffer; }
  
    private:
      std::vector<uint8_t> mReadBuffer;
      std::vector<const uint8_t *> mPointersBuffer;
      gl::AttribArray<std::vector<uint8_t>> mClientArraysBuffer;
  };
  
  // Helper to use unique IDs for each local data variable.
  class DataCounters final : angle::NonCopyable
  {
    public:
      DataCounters();
      ~DataCounters();
  
      int getAndIncrement(gl::EntryPoint entryPoint, const std::string &paramName);
  
    private:
      // <CallName, ParamName>
      using Counter = std::pair<gl::EntryPoint, std::string>;
      std::map<Counter, int> mData;
  };
  
  // Used by the CPP replay to filter out unnecessary code.
  using HasResourceTypeMap = angle::PackedEnumBitSet<ResourceIDType>;
  
  // Map of buffing bindings to offset and size used when mapped
  using BufferDataMap = std::map<gl::BufferBinding, std::pair<GLintptr, GLsizeiptr>>;
  
  // A dictionary of sources indexed by shader type.
  using ProgramSources = gl::ShaderMap<std::string>;
  
  // Maps from IDs to sources.
  using ShaderSourceMap  = std::map<gl::ShaderProgramID, std::string>;
  using ProgramSourceMap = std::map<gl::ShaderProgramID, ProgramSources>;
  
  // Map from textureID to level and data
  using TextureLevels       = std::map<GLint, std::vector<uint8_t>>;
  using TextureLevelDataMap = std::map<gl::TextureID, TextureLevels>;
  
  class FrameCapture final : angle::NonCopyable
  {
    public:
      FrameCapture();
      ~FrameCapture();
  
      void captureCall(const gl::Context *context, CallCapture &&call);
      void onEndFrame(const gl::Context *context);
      bool enabled() const;
      void replay(gl::Context *context);
  
    private:
      void captureClientArraySnapshot(const gl::Context *context,
                                      size_t vertexCount,
                                      size_t instanceCount);
      void captureMappedBufferSnapshot(const gl::Context *context, const CallCapture &call);
  
      void captureCompressedTextureData(const gl::Context *context, const CallCapture &call);
  
      void reset();
      void maybeCaptureClientData(const gl::Context *context, const CallCapture &call);
      void maybeCapturePostCallUpdates(const gl::Context *context);
  
      static void ReplayCall(gl::Context *context,
                             ReplayContext *replayContext,
                             const CallCapture &call);
  
      std::vector<CallCapture> mSetupCalls;
      std::vector<CallCapture> mFrameCalls;
      std::vector<CallCapture> mTearDownCalls;
  
      bool mEnabled;
      std::string mOutDirectory;
      std::string mCaptureLabel;
      gl::AttribArray<int> mClientVertexArrayMap;
      uint32_t mFrameIndex;
      uint32_t mFrameStart;
      uint32_t mFrameEnd;
      gl::AttribArray<size_t> mClientArraySizes;
      size_t mReadBufferSize;
      HasResourceTypeMap mHasResourceType;
      BufferDataMap mBufferDataMap;
  
      // Cache most recently compiled and linked sources.
      ShaderSourceMap mCachedShaderSources;
      ProgramSourceMap mCachedProgramSources;
  
      // Cache a shadow copy of texture level data
      TextureLevels mCachedTextureLevels;
      TextureLevelDataMap mCachedTextureLevelData;
  };
  
  template <typename CaptureFuncT, typename... ArgsT>
  void CaptureCallToFrameCapture(CaptureFuncT captureFunc,
                                 bool isCallValid,
                                 gl::Context *context,
                                 ArgsT... captureParams)
  {
      FrameCapture *frameCapture = context->getFrameCapture();
      if (!frameCapture->enabled())
          return;
  
      CallCapture call = captureFunc(context->getState(), isCallValid, captureParams...);
      frameCapture->captureCall(context, std::move(call));
  }
  
  template <typename T>
  void ParamBuffer::addValueParam(const char *paramName, ParamType paramType, T paramValue)
  {
      ParamCapture capture(paramName, paramType);
      InitParamValue(paramType, paramValue, &capture.value);
      mParamCaptures.emplace_back(std::move(capture));
  }
  
  template <typename T>
  void ParamBuffer::addEnumParam(const char *paramName,
                                 gl::GLenumGroup enumGroup,
                                 ParamType paramType,
                                 T paramValue)
  {
      ParamCapture capture(paramName, paramType);
      InitParamValue(paramType, paramValue, &capture.value);
      capture.enumGroup = enumGroup;
      mParamCaptures.emplace_back(std::move(capture));
  }
  
  std::ostream &operator<<(std::ostream &os, const ParamCapture &capture);
  
  // Pointer capture helpers.
  void CaptureMemory(const void *source, size_t size, ParamCapture *paramCapture);
  void CaptureString(const GLchar *str, ParamCapture *paramCapture);
  
  gl::Program *GetLinkedProgramForCapture(const gl::State &glState, gl::ShaderProgramID handle);
  
  // For GetIntegerv, GetFloatv, etc.
  void CaptureGetParameter(const gl::State &glState,
                           GLenum pname,
                           size_t typeSize,
                           ParamCapture *paramCapture);
  
  void CaptureGenHandlesImpl(GLsizei n, GLuint *handles, ParamCapture *paramCapture);
  
  template <typename T>
  void CaptureGenHandles(GLsizei n, T *handles, ParamCapture *paramCapture)
  {
      CaptureGenHandlesImpl(n, reinterpret_cast<GLuint *>(handles), paramCapture);
  }
  
  template <ParamType ParamT, typename T>
  void WriteParamValueReplay(std::ostream &os, const CallCapture &call, T value);
  
  template <>
  void WriteParamValueReplay<ParamType::TGLboolean>(std::ostream &os,
                                                    const CallCapture &call,
                                                    GLboolean value);
  
  template <>
  void WriteParamValueReplay<ParamType::TvoidConstPointer>(std::ostream &os,
                                                           const CallCapture &call,
                                                           const void *value);
  
  template <>
  void WriteParamValueReplay<ParamType::TGLDEBUGPROCKHR>(std::ostream &os,
                                                         const CallCapture &call,
                                                         GLDEBUGPROCKHR value);
  
  template <>
  void WriteParamValueReplay<ParamType::TGLDEBUGPROC>(std::ostream &os,
                                                      const CallCapture &call,
                                                      GLDEBUGPROC value);
  
  template <>
  void WriteParamValueReplay<ParamType::TBufferID>(std::ostream &os,
                                                   const CallCapture &call,
                                                   gl::BufferID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TFenceNVID>(std::ostream &os,
                                                    const CallCapture &call,
                                                    gl::FenceNVID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TFramebufferID>(std::ostream &os,
                                                        const CallCapture &call,
                                                        gl::FramebufferID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TMemoryObjectID>(std::ostream &os,
                                                         const CallCapture &call,
                                                         gl::MemoryObjectID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TPathID>(std::ostream &os,
                                                 const CallCapture &call,
                                                 gl::PathID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TProgramPipelineID>(std::ostream &os,
                                                            const CallCapture &call,
                                                            gl::ProgramPipelineID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TQueryID>(std::ostream &os,
                                                  const CallCapture &call,
                                                  gl::QueryID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TRenderbufferID>(std::ostream &os,
                                                         const CallCapture &call,
                                                         gl::RenderbufferID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TSamplerID>(std::ostream &os,
                                                    const CallCapture &call,
                                                    gl::SamplerID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TSemaphoreID>(std::ostream &os,
                                                      const CallCapture &call,
                                                      gl::SemaphoreID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TShaderProgramID>(std::ostream &os,
                                                          const CallCapture &call,
                                                          gl::ShaderProgramID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TTextureID>(std::ostream &os,
                                                    const CallCapture &call,
                                                    gl::TextureID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TTransformFeedbackID>(std::ostream &os,
                                                              const CallCapture &call,
                                                              gl::TransformFeedbackID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TVertexArrayID>(std::ostream &os,
                                                        const CallCapture &call,
                                                        gl::VertexArrayID value);
  
  template <>
  void WriteParamValueReplay<ParamType::TUniformLocation>(std::ostream &os,
                                                          const CallCapture &call,
                                                          gl::UniformLocation value);
  
  // General fallback for any unspecific type.
  template <ParamType ParamT, typename T>
  void WriteParamValueReplay(std::ostream &os, const CallCapture &call, T value)
  {
      os << value;
  }
  }  // namespace angle
  
  #endif  // LIBANGLE_FRAME_CAPTURE_H_
  

Download