gz/common/Profiler.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef GZ_COMMON_PROFILER_HH_
#define GZ_COMMON_PROFILER_HH_
 
#include <cstdint>
#include <memory>
#include <string>
 
#include <gz/common/config.hh>
#include <gz/common/profiler/Export.hh>
#include <gz/common/SingletonT.hh>
 
#include "ProfilerImpl.hh"
 
namespace gz
{
  namespace common
  {
    class GZ_COMMON_PROFILER_VISIBLE Profiler
        : public virtual SingletonT<Profiler>
    {
      protected: Profiler();
 
      protected: ~Profiler();
 
      public: void SetThreadName(const char *_name);
 
      public: void LogText(const char *_text);
 
      public: void BeginSample(const char *_name, uint32_t *_hash = nullptr);
 
      public: void EndSample();
 
      public: bool SetImplementation(std::unique_ptr<ProfilerImpl> _impl);
 
      public: std::string ImplementationName() const;
 
      public: bool Valid() const;
 
      private: ProfilerImpl *impl;
 
      private: friend class SingletonT<Profiler>;
    };
 
    class GZ_COMMON_PROFILER_VISIBLE ScopedProfile
    {
      public: ScopedProfile(const char *_name, uint32_t *_hash)
      {
        Profiler::Instance()->BeginSample(_name, _hash);
      }
 
      public: ~ScopedProfile()
      {
        Profiler::Instance()->EndSample();
      }
    };
  }
}
 
#ifndef GZ_PROFILER_ENABLE
#define GZ_PROFILER_ENABLE 0
#endif
 
#if GZ_PROFILER_ENABLE
#define GZ_PROFILE_THREAD_NAME(name) \
    gz::common::Profiler::Instance()->SetThreadName(name);
#define GZ_PROFILE_LOG_TEXT(name) \
    gz::common::Profiler::Instance()->LogText(name);
#define GZ_PROFILE_BEGIN(name) \
    gz::common::Profiler::Instance()->BeginSample(name)
#define GZ_PROFILE_END() \
    gz::common::Profiler::Instance()->EndSample()
 
#define GZ_PROFILE_L(name, line) \
static uint32_t __hash##line = 0; \
gz::common::ScopedProfile __profile##line(name, &__hash##line);
#define GZ_PROFILE(name)             GZ_PROFILE_L(name, __LINE__);
 
#else
 
#define GZ_PROFILE_THREAD_NAME(name) ((void) name)
#define GZ_PROFILE_LOG_TEXT(name)    ((void) name)
#define GZ_PROFILE_BEGIN(name)       ((void) name)
#define GZ_PROFILE_END()             ((void) 0)
#define GZ_PROFILE_L(name, line)     ((void) name)
#define GZ_PROFILE(name)             ((void) name)
#endif  // GZ_PROFILER_ENABLE
 
#define GZ_PROFILER_VALID \
    GZ_PROFILER_ENABLE && gz::common::Profiler::Instance()->Valid()
 
#endif  // GZ_COMMON_PROFILER_HH_