macSignpost.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2018, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef MAC_SIGNPOST_H
#define MAC_SIGNPOST_H
 
 
#if defined(__APPLE__)
 
#include "macVersionMacros.h"
 
//
//   /* Create once, e.g. in Constructor */
//   os_log_t splog = macosSignpostLog_CREATE(::getenv("MYENVVAR_SIGNPOSTS_ENABLED")!=NULL, "com.mycompany.myproduct", "CategoryA");
//
//   /* Measure critical section */
//   macosSignpostInterval_BEGIN(splog, "MyFunc", "AlgoA %{public}s", myDynamicString);
//   ...
//   macosSignpostInterval_END(splog, "MyFunc", "AlgoA %{public}s", myDynamicString);
//
//   /* Use Apple Instruments with Instrument 'os_signpost' for inspection */
//
 
// Signpost is available with macOS 10.14 and requires the unified logging system introduced with macOS 10.12
#if __has_include(<os/signpost.h>)
 
#define macosSignpostAPIIsDeclared  1
#include <os/signpost.h>
 
#define macosSignpostLog_CREATE(enable, subsystem, category) \
  []{ \
    if (__builtin_available(macOS 10.14, *)) { \
      return (enable) ? os_log_create(subsystem, category) : OS_LOG_DISABLED; \
    } else { \
      return OS_LOG_DISABLED; \
    } \
  }()
 
#define macosSignpostInterval_BEGIN(log, name, ...) \
  os_signpost_id_t _local_interval_id; \
  if (__builtin_available(macOS 10.14, *)) { \
    _local_interval_id = os_signpost_id_generate(log); \
    os_signpost_interval_begin(log, _local_interval_id, name, ##__VA_ARGS__); \
  }
 
#define macosSignpostInterval_END(log, name, ...) \
  if (__builtin_available(macOS 10.14, *)) { \
    os_signpost_interval_end(log, _local_interval_id, name, ##__VA_ARGS__); \
  }
 
#define macosSignpostAssociatedEvent_EMIT(log, name, ...) \
  if (__builtin_available(macOS 10.14, *)) { \
    os_signpost_event_emit(log, _local_interval_id, name, ##__VA_ARGS__); \
  }
 
#define macosSignpostExclusiveEvent_EMIT(log, name, ...) \
  if (__builtin_available(macOS 10.14, *)) { \
    os_signpost_event_emit(log, OS_SIGNPOST_ID_EXCLUSIVE, name, ##__VA_ARGS__); \
  }
 
#else
 
#include <stdint.h>
 
// Declare some types for use in structs and classes
typedef void     *os_log_t;
typedef uint64_t  os_signpost_id_t;
 
#define OS_LOG_DISABLED ((os_log_t)NULL)
 
#define macosSignpostLog_CREATE(env_var, subsystem, category) OS_LOG_DISABLED
#define macosSignpostInterval_BEGIN(log, name, ...) {}
#define macosSignpostInterval_END(log, name, ...) {}
#define macosSignpostAssociatedEvent_EMIT(log, name, ...) {}
#define macosSignpostExclusiveEvent_EMIT(log, name, ...) {}
 
#endif
 
#endif  // __APPLE__
#endif  // __macSignpost_H