Bug 39646 – Web Inspector: add Console API for retrieving memory stats

• Component: Web Inspector (Deprecated)
• Status: RESOLVED FIXED

[Mikhail Naganov]

The first thing that can be added is JS heap size stats. Monitoring them is useful for continuous builds for catching regressions.

My proposal is to add 'console.memoryStats()' method which returns an object. Currently it has two fields: totalHeapSize and usedHeapSize. Later, it can be extended for reporting total browser's memory consumption.

[Mikhail Naganov]

Created attachment 56972 [details]
proposed patch

[WebKit Review Bot]

Attachment 56972 [details] did not pass style-queue:

Failed to run "['WebKitTools/Scripts/check-webkit-style', '--no-squash']" exit_code: 1
WebCore/page/Console.cpp:450:  Place brace on its own line for function definitions.  [whitespace/braces] [4]
Total errors found: 1 in 4 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Mikhail Naganov]

Created attachment 57021 [details]
fixed lint error

[Pavel Feldman]

Comment on attachment 57021 [details]
fixed lint error

Please land manually once you get xenon's LG on this.

[Mikhail Naganov]

Created attachment 57239 [details]
Implemented as 'console.memory' object after chatting with xenon

[WebKit Commit Bot]

Comment on attachment 57239 [details]
Implemented as 'console.memory' object after chatting with xenon

Rejecting patch 57239 from commit-queue.

Failed to run "['WebKitTools/Scripts/run-webkit-tests', '--no-launch-safari', '--exit-after-n-failures=1', '--ignore-tests', 'compositing', '--quiet']" exit_code: 1
Last 500 characters of output:
ree
Compiling Java tests
make: Nothing to be done for `default'.
Running tests from /Users/eseidel/Projects/CommitQueue/LayoutTests
Skipped list contained 'compositing/iframes/composited-iframe.html', but no file of that name could be found
Testing 19005 test cases.
fast/dom/Window/window-properties.html -> failed

Exiting early after 1 failures. 6751 tests run.
124.46s total testing time

6750 test cases (99%) succeeded
1 test case (<1%) had incorrect layout
1 test case (<1%) had stderr output

Full output: http://webkit-commit-queue.appspot.com/results/2554059

[Mikhail Naganov]

Created attachment 57320 [details]
now with updated test expectations!

[Pavel Feldman]

Comment on attachment 57320 [details]
now with updated test expectations!

Oh, my bad. As ggaren pointed out, we need to make sure client code works fine no matter whether dev extras / inspector are there or not. So we need to make sure that console.memory object presents at all times. It may have no properties in case instrumentation is not available.

[Eric Seidel (no email)]

Comment on attachment 57021 [details]
fixed lint error

Cleared Pavel Feldman's review+ from obsolete attachment 57021 [details] so that this bug does not appear in http://webkit.org/pending-commit.

[Eric Seidel (no email)]

Comment on attachment 57239 [details]
Implemented as 'console.memory' object after chatting with xenon

Cleared Pavel Feldman's review+ from obsolete attachment 57239 [details] so that this bug does not appear in http://webkit.org/pending-commit.

[Mikhail Naganov]

Created attachment 57637 [details]
Introduce MemoryInfo interface to access memory statistics

[Yury Semikhatsky]

Comment on attachment 57637 [details]
Introduce MemoryInfo interface to access memory statistics

WebCore/GNUmakefile.am:298
 +  	WebCore/page/MemoryInfo.idl \
Wrong ordering

WebCore/page/MemoryInfo.idl:35
 +          readonly attribute unsigned long totalHeapSize;
We may want to be more specific about what exactly heap size it is if we want at some point to provide total browser heap size.

WebCore/page/MemoryInfo.h:43
 +      unsigned long totalHeapSize() const { return m_totalHeapSize; }
Why is it unsigned ling and not size_t?

[Mikhail Naganov]

Created attachment 57650 [details]
Yury's comments addressed

[Mikhail Naganov]

Reverted r60563 for reason:

windows build failed

Committed r60565: <http://trac.webkit.org/changeset/60565>

[WebKit Review Bot]

http://trac.webkit.org/changeset/60563 might have broken Leopard Intel Release (Tests)

[Mikhail Naganov]

Created attachment 57662 [details]
Fixed windows build and test expectations

[Mikhail Naganov]

Committed manually: http://trac.webkit.org/changeset/60568

    2010-06-02  Mikhail Naganov  <[e-mail]>
    
            Reviewed by Yuri Semikhatsky.
    
            Web Inspector: add Console API for retrieving memory stats
    
            Add 'console.memory' property which returns an object. Currently
            it has two fields: totalJSHeapSize and usedJSHeapSize. Later, it can be
            extended for reporting total browser's memory consumption.
    
            https://bugs.webkit.org/show_bug.cgi?id=39646
    
            * CMakeLists.txt:
            * DerivedSources.cpp:
            * DerivedSources.make:
            * GNUmakefile.am:
            * WebCore.gypi:
            * WebCore.pri:
            * WebCore.pro:
            * WebCore.vcproj/WebCore.vcproj:
            * WebCore.xcodeproj/project.pbxproj:
            * bindings/js/JSBindingsAllInOne.cpp:
            * bindings/js/JSConsoleCustom.cpp:
            (WebCore::JSConsole::memory):
            * bindings/v8/custom/V8ConsoleCustom.cpp:
            (WebCore::V8Console::memoryAccessorGetter):
            * page/Console.h:
            * page/Console.idl:
            * page/MemoryInfo.cpp: Added.
            (WebCore::MemoryInfo::MemoryInfo):
            * page/MemoryInfo.h: Added.
            (WebCore::MemoryInfo::create):
            (WebCore::MemoryInfo::totalJSHeapSize):
            (WebCore::MemoryInfo::usedJSHeapSize):
            * page/MemoryInfo.idl: Added.
            * fast/dom/Window/window-properties-expected.txt:
            * fast/dom/prototype-inheritance-2-expected.txt:
            * platform/gtk/fast/dom/Window/window-properties-expected.txt:
            * platform/qt/fast/dom/Window/window-properties-expected.txt:
            * platform/win/fast/dom/prototype-inheritance-2-expected.txt: