Add UMA histograms for WebAudio

third_party/WebKit/Source/modules/webaudio/OfflineAudioContext.cpp

 /*
  * Copyright (C) 2012, Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1.  Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 17 matching lines @@
 #include "bindings/core/v8/ScriptState.h"
 #include "core/dom/DOMException.h"
 #include "core/dom/Document.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/dom/ExecutionContext.h"
 #include "modules/webaudio/AudioListener.h"
 #include "modules/webaudio/DeferredTaskHandler.h"
 #include "modules/webaudio/OfflineAudioCompletionEvent.h"
 #include "modules/webaudio/OfflineAudioDestinationNode.h"
 
+#include "platform/Histogram.h"
 #include "platform/audio/AudioUtilities.h"
 
 namespace blink {
 
 OfflineAudioContext* OfflineAudioContext::create(ExecutionContext* context, unsigned numberOfChannels, unsigned numberOfFrames, float sampleRate, ExceptionState& exceptionState)
 {
     // FIXME: add support for workers.
     if (!context || !context->isDocument()) {
         exceptionState.throwDOMException(
             NotSupportedError,
@@ skipping 35 matching lines @@
 
     if (!audioContext->destination()) {
         exceptionState.throwDOMException(
             NotSupportedError,
             "OfflineAudioContext(" + String::number(numberOfChannels)
             + ", " + String::number(numberOfFrames)
             + ", " + String::number(sampleRate)
             + ")");
     }
 
+    DEFINE_STATIC_LOCAL(SparseHistogram, offlineContextChannelCountHistogram,

[Mark P, 2016/05/23 18:10:24]

SparseHistograms are slow because they acquire a lock each time you emit to
them.
Are you sure you want to use the type of histogram here?
I would think for most of these counts an appropriate COUNT or ENUMERATED
histogram would be better.
ditto with all your other histogram usages in other files in this changelist.

[Raymond Toy, 2016/05/23 20:36:03]

We don't expect many offline contexts, so speed isn't important. (Plus we're
thread-limited on the number of simultaneous contexts.)
Yes, after your initial comment (about adding units), I see there are lots of
other types that we should consider. 

[Mark P, 2016/05/23 21:30:24]

Yes, I would encourage you to use other types when it feels appropriate.  Even
if speed isn't an issue, one thing to keep in mind is that sparse histograms can
grow in memory unbounded if you keep emitting distinct values to them.

[Raymond Toy, 2016/05/23 23:12:00]

Unboundedness might be problem?  Not really sure, but I suspect the sample rates
are probably the typical audio hardware sample rates (44.1 kHz, 48 kHz, mostly
and maybe 192).  The possible rates allowed by WebAudio are 3000-192000 Hz.

[Mark P, 2016/06/03 19:52:36]

I'm still nervous about these being sparse histograms.
I can easily imagine a web page showing off fun features, say, do something like
for i = 0 to 10000 {
  create and play audio context of length i
}
or
// Listen how sample rates affect things
for i = 3k to 192k {
  create and play audio context with sample rate of length i
}
and the browser's memory will expand substantially (O(megabytes)), which will
not be released until a reboot.

Are you comfortable with this penalty when webaudio pages do strange things? 
(Or are you sure no one is going to do strange things.)

And if the length goes from, say, 0 to 10m instead, we're talking hundreds of
megabytes.

...

Actually, I just noticed you use sparse histograms in many places in this
changelist.  I'll emphasize again that such histograms keep every distinct value
emitted to in memory for as long as chrome is running.  Please audit these to
make sure the distinct values in each histogram is going to be from a small set.

+        ("WebAudio.OfflineAudioContext.ChannelCount"));
+    DEFINE_STATIC_LOCAL(SparseHistogram, offlineContextSampleRateHistogram,
+        ("WebAudio.OfflineAudioContext.SampleRate"));
+    DEFINE_STATIC_LOCAL(SparseHistogram, offlineContextLengthHistogram,
+        ("WebAudio.OfflineAudioContext.Length"));
+
+    offlineContextChannelCountHistogram.sample(numberOfChannels);
+    offlineContextSampleRateHistogram.sample(static_cast<int>(sampleRate));
+    offlineContextLengthHistogram.sample(clampTo(numberOfFrames, 0, std::numeric_limits<int>::max()));
+
     audioContext->suspendIfNeeded();
     return audioContext;
 }
 
 OfflineAudioContext::OfflineAudioContext(Document* document, unsigned numberOfChannels, size_t numberOfFrames, float sampleRate, ExceptionState& exceptionState)
     : AbstractAudioContext(document, numberOfChannels, numberOfFrames, sampleRate)
     , m_isRenderingStarted(false)
     , m_totalRenderFrames(numberOfFrames)
 {
     // Create a new destination for offline rendering.
@@ skipping 313 matching lines @@
     // Note that the GraphLock is required before this check. Since this needs
     // to run on the audio thread, OfflineGraphAutoLocker must be used.
     if (m_scheduledSuspends.contains(currentSampleFrame()))
         return true;
 
     return false;
 }
 
 } // namespace blink