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

• Show log

  Commit

• Hash : 2aa5286d
  Author :
  Date : 2021-10-12T17:05:48
  

  Add Entry Point name to validation errors
  
  Add gl/gles entry point names to validation error messages
  
  some special cases:
  1. Debug::insertPerfWarning() is invoked from multiple places,
  such as TextureVK, ContextVK,
  adding an extra entryPoint function parameter
  in these files will need
  extra investigations.
  I am passing the entryPoint name GLInvalid as a
  temp workaround.
  
  2.ErrorSet::hangleError() is invoked from multiple
  Context*.cpp files,
  adding an extra entryPoint function parameter
  in these files will need
  extra investigations.
  I am passing the entryPoint name GLInvalid as a
  temp workaround.
  
  3. Debug::insertMessage(), Debug::popGroup(), Debug::pushGroup()
  can be invoked from more than one GL entry points,
  e.g. Debug::pushGroup() can be invoked from
  either GL_APIENTRY GL_PushDebugGroup() or
  GL_APIENTRY GL_PushDebugGroupKHR()
  through context->pushDebugGroup() call.
  Right now the same entry point name glPushDebugGroup will
  be printed out in the error message for both cases.
  However, we should be able to tell the actual entry point
  by checking which version: KHR version or core version the
  application uses, and this helps avoid the confusion.
  For now we will let the same entry point name
  getting printed for both cases.
  
  Bug: angleproject:6523
  Change-Id: I64a5463d9168d8444d376d1f428c3b3d894f2ea9
  Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/3215063
  Reviewed-by: Jamie Madill <jmadill@chromium.org>
  Reviewed-by: Shahbaz Youssefi <syoussefi@chromium.org>
  Commit-Queue: Yuxin Hu <yuxinhu@google.com>
  

Download

• src/libANGLE/Debug.h

• //
  // Copyright 2015 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.
  //
  
  // Debug.h: Defines debug state used for GL_KHR_debug
  
  #ifndef LIBANGLE_DEBUG_H_
  #define LIBANGLE_DEBUG_H_
  
  #include "angle_gl.h"
  #include "common/PackedEnums.h"
  #include "common/angleutils.h"
  #include "libANGLE/AttributeMap.h"
  
  #include <deque>
  #include <string>
  #include <vector>
  
  namespace gl
  {
  class Context;
  
  class LabeledObject
  {
    public:
      virtual ~LabeledObject() {}
      virtual void setLabel(const Context *context, const std::string &label) = 0;
      virtual const std::string &getLabel() const                             = 0;
  };
  
  class Debug : angle::NonCopyable
  {
    public:
      Debug(bool initialDebugState);
      ~Debug();
  
      void setMaxLoggedMessages(GLuint maxLoggedMessages);
  
      void setOutputEnabled(bool enabled);
      bool isOutputEnabled() const;
  
      void setOutputSynchronous(bool synchronous);
      bool isOutputSynchronous() const;
  
      void setCallback(GLDEBUGPROCKHR callback, const void *userParam);
      GLDEBUGPROCKHR getCallback() const;
      const void *getUserParam() const;
  
      void insertMessage(GLenum source,
                         GLenum type,
                         GLuint id,
                         GLenum severity,
                         const std::string &message,
                         gl::LogSeverity logSeverity,
                         angle::EntryPoint entryPoint) const;
      void insertMessage(GLenum source,
                         GLenum type,
                         GLuint id,
                         GLenum severity,
                         std::string &&message,
                         gl::LogSeverity logSeverity,
                         angle::EntryPoint entryPoint) const;
  
      void setMessageControl(GLenum source,
                             GLenum type,
                             GLenum severity,
                             std::vector<GLuint> &&ids,
                             bool enabled);
      size_t getMessages(GLuint count,
                         GLsizei bufSize,
                         GLenum *sources,
                         GLenum *types,
                         GLuint *ids,
                         GLenum *severities,
                         GLsizei *lengths,
                         GLchar *messageLog);
      size_t getNextMessageLength() const;
      size_t getMessageCount() const;
  
      void pushGroup(GLenum source, GLuint id, std::string &&message);
      void popGroup();
      size_t getGroupStackDepth() const;
  
      // Helper for ANGLE_PERF_WARNING
      void insertPerfWarning(GLenum severity, const char *message, uint32_t *repeatCount) const;
  
    private:
      bool isMessageEnabled(GLenum source, GLenum type, GLuint id, GLenum severity) const;
  
      void pushDefaultGroup();
  
      struct Message
      {
          GLenum source;
          GLenum type;
          GLuint id;
          GLenum severity;
          std::string message;
      };
  
      struct Control
      {
          Control();
          ~Control();
          Control(const Control &other);
  
          GLenum source;
          GLenum type;
          GLenum severity;
          std::vector<GLuint> ids;
          bool enabled;
      };
  
      struct Group
      {
          Group();
          ~Group();
          Group(const Group &other);
  
          GLenum source;
          GLuint id;
          std::string message;
  
          std::vector<Control> controls;
      };
  
      bool mOutputEnabled;
      GLDEBUGPROCKHR mCallbackFunction;
      const void *mCallbackUserParam;
      mutable std::deque<Message> mMessages;
      GLuint mMaxLoggedMessages;
      bool mOutputSynchronous;
      std::vector<Group> mGroups;
  };
  }  // namespace gl
  
  namespace egl
  {
  class LabeledObject
  {
    public:
      virtual ~LabeledObject() {}
      virtual void setLabel(EGLLabelKHR label) = 0;
      virtual EGLLabelKHR getLabel() const     = 0;
  };
  
  class Debug : angle::NonCopyable
  {
    public:
      Debug();
  
      void setCallback(EGLDEBUGPROCKHR callback, const AttributeMap &attribs);
      EGLDEBUGPROCKHR getCallback() const;
      bool isMessageTypeEnabled(MessageType type) const;
  
      void insertMessage(EGLenum error,
                         const char *command,
                         MessageType messageType,
                         EGLLabelKHR threadLabel,
                         EGLLabelKHR objectLabel,
                         const std::string &message) const;
  
    private:
      EGLDEBUGPROCKHR mCallback;
      angle::PackedEnumBitSet<MessageType> mEnabledMessageTypes;
  };
  }  // namespace egl
  
  // Generate a perf warning.  Only outputs the same message a few times to avoid spamming the logs.
  #define ANGLE_PERF_WARNING(debug, severity, message)                 \
      do                                                               \
      {                                                                \
          static uint32_t sRepeatCount = 0;                            \
          (debug).insertPerfWarning(severity, message, &sRepeatCount); \
      } while (0)
  
  #endif  // LIBANGLE_DEBUG_H_
  

Download