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 IGNITION_COMMON_PROFILER_HH_
#define IGNITION_COMMON_PROFILER_HH_

#include <memory>
#include <string>

#include <ignition/common/profiler/Export.hh>
#include <ignition/common/SingletonT.hh>
#include <ignition/common/config.hh>

namespace ignition
{
  namespace common
  {
    class ProfilerImpl;

    class IGNITION_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: std::string ImplementationName() const;

      public: bool Valid() const;

      private: ProfilerImpl *impl;

      private: friend class SingletonT<Profiler>;
    };

    class IGNITION_COMMON_PROFILER_VISIBLE ScopedProfile
    {
      public: ScopedProfile(const char *_name, uint32_t *_hash)
      {
        Profiler::Instance()->BeginSample(_name, _hash);
      }

      public: ~ScopedProfile()
      {
        Profiler::Instance()->EndSample();
      }
    };
  }
}

#ifndef IGN_PROFILER_ENABLE
#define IGN_PROFILER_ENABLE 0
#endif

#if IGN_PROFILER_ENABLE
#define IGN_PROFILE_THREAD_NAME(name) \
    ignition::common::Profiler::Instance()->SetThreadName(name);
#define IGN_PROFILE_LOG_TEXT(name) \
    ignition::common::Profiler::Instance()->LogText(name);
#define IGN_PROFILE_BEGIN(name) \
    ignition::common::Profiler::Instance()->BeginSample(name)
#define IGN_PROFILE_END() \
    ignition::common::Profiler::Instance()->EndSample()

#define IGN_PROFILE_L(name, line) \
static uint32_t __hash##line = 0; \
ignition::common::ScopedProfile __profile##line(name, &__hash##line);
#define IGN_PROFILE(name)             IGN_PROFILE_L(name, __LINE__);

#else

#define IGN_PROFILE_THREAD_NAME(name) ((void) name)
#define IGN_PROFILE_LOG_TEXT(name)    ((void) name)
#define IGN_PROFILE_BEGIN(name)       ((void) name)
#define IGN_PROFILE_END()             ((void) 0)
#define IGN_PROFILE_L(name, line)     ((void) name)
#define IGN_PROFILE(name)             ((void) name)
#endif  // IGN_PROFILER_ENABLE

#define IGN_PROFILER_VALID \
    IGN_PROFILER_ENABLE && ignition::common::Profiler::Instance()->Valid()

#endif  // IGNITION_COMMON_PROFILER_HH_