skia/ext/skia_histogram.h

// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SKIA_EXT_SKIA_HISTOGRAM_H_
#define SKIA_EXT_SKIA_HISTOGRAM_H_

#include <stddef.h>
#include <stdint.h>

#include <atomic>
#include <memory>

// This file exposes Chrome's histogram functionality to Skia, without bringing
// in any Chrome specific headers. To achieve the same level of optimization as
// is present in Chrome, we need to use an inlined atomic pointer. This macro
// defines a placeholder atomic which will be inlined into the call-site. This
// placeholder is passed to the actual histogram logic in Chrome.
#define SK_HISTOGRAM_POINTER_HELPER(function, ...)                   \
  do {                                                               \
    static std::atomic_uintptr_t atomic_histogram_pointer;           \
    function(std::addressof(atomic_histogram_pointer), __VA_ARGS__); \
  } while (0)

#define SK_HISTOGRAM_BOOLEAN(name, sample) \
  SK_HISTOGRAM_POINTER_HELPER(skia::HistogramBoolean, "Skia." name, sample)

#define SK_HISTOGRAM_ENUMERATION(name, sample, enum_size)               \
  SK_HISTOGRAM_POINTER_HELPER(skia::HistogramEnumeration, "Skia." name, \
                              sample, enum_size)

#define SK_HISTOGRAM_EXACT_LINEAR(name, sample, value_max)              \
  SK_HISTOGRAM_POINTER_HELPER(skia::HistogramExactLinear, "Skia." name, \
                              sample, value_max)

#define SK_HISTOGRAM_CUSTOM_EXACT_LINEAR(name, sample, value_min, value_max,  \
                                         bucket_count)                        \
  SK_HISTOGRAM_POINTER_HELPER(skia::HistogramCustomExactLinear, "Skia." name, \
                              sample, value_min, value_max, bucket_count)

#define SK_HISTOGRAM_MEMORY_KB(name, sample) \
  SK_HISTOGRAM_POINTER_HELPER(skia::HistogramMemoryKB, "Skia." name, sample)

#define SK_HISTOGRAM_CUSTOM_COUNTS(name, sample, min_count, max_count,   \
                                   bucket_count)                         \
  SK_HISTOGRAM_POINTER_HELPER(skia::HistogramCustomCounts, "Skia." name, \
                              sample, min_count, max_count, bucket_count);

#define SK_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(name, sample_usec, min_usec,  \
                                               max_usec, bucket_count)       \
  SK_HISTOGRAM_POINTER_HELPER(skia::HistogramCustomMicrosecondsTimes,        \
                              "Skia." name, sample_usec, min_usec, max_usec, \
                              bucket_count);

namespace skia {

void HistogramBoolean(std::atomic_uintptr_t* atomic_histogram_pointer,
                      const char* name,
                      bool sample);
void HistogramEnumeration(std::atomic_uintptr_t* atomic_histogram_pointer,
                          const char* name,
                          int sample,
                          int enum_size);
void HistogramExactLinear(std::atomic_uintptr_t* atomic_histogram_pointer,
                          const char* name,
                          int sample,
                          int value_max);
void HistogramCustomExactLinear(std::atomic_uintptr_t* atomic_histogram_pointer,
                                const char* name,
                                int sample,
                                int value_min,
                                int value_max,
                                size_t bucket_count);
void HistogramMemoryKB(std::atomic_uintptr_t* atomic_histogram_pointer,
                       const char* name,
                       int sample);
void HistogramCustomCounts(std::atomic_uintptr_t* atomic_histogram_pointer,
                           const char* name,
                           int sample,
                           int min_count,
                           int max_count,
                           size_t bucket_count);
void HistogramCustomMicrosecondsTimes(
    std::atomic_uintptr_t* atomic_histogram_pointer,
    const char* name,
    int64_t sample_usec,
    unsigned min_usec,
    unsigned max_usec,
    size_t bucket_count);

}  // namespace skia

#endif  // SKIA_EXT_SKIA_HISTOGRAM_H_