memoryFootprint should return size_t not optional<size_t>
[WebKit-https.git] / Source / WTF / wtf / win / MemoryFootprintWin.cpp
1 /*
2  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "MemoryFootprint.h"
28
29 #include <algorithm>
30 #include <type_traits>
31 #include <windows.h>
32 #include <psapi.h>
33 #include <wtf/MallocPtr.h>
34 #include <wtf/win/Win32Handle.h>
35
36 namespace WTF {
37
38 size_t memoryFootprint()
39 {
40     // We would like to calculate size of private working set.
41     // https://msdn.microsoft.com/en-us/library/windows/desktop/ms684891(v=vs.85).aspx
42     // > The working set of a program is a collection of those pages in its virtual address
43     // > space that have been recently referenced. It includes both shared and private data.
44     // > The shared data includes pages that contain all instructions your application executes,
45     // > including those in your DLLs and the system DLLs. As the working set size increases,
46     // > memory demand increases.
47     Win32Handle process(OpenProcess(PROCESS_QUERY_INFORMATION, FALSE, GetCurrentProcessId()));
48     if (!process.isValid())
49         return 0;
50
51     auto countSizeOfPrivateWorkingSet = [] (const PSAPI_WORKING_SET_INFORMATION& workingSets) {
52         constexpr const size_t pageSize = 4 * KB;
53         size_t numberOfPrivateWorkingSetPages = 0;
54         for (size_t i = 0; i < workingSets.NumberOfEntries; ++i) {
55             // https://msdn.microsoft.com/en-us/library/windows/desktop/ms684902(v=vs.85).aspx
56             PSAPI_WORKING_SET_BLOCK workingSetBlock = workingSets.WorkingSetInfo[i];
57             if (!workingSetBlock.Shared)
58                 numberOfPrivateWorkingSetPages++;
59         }
60         return numberOfPrivateWorkingSetPages * pageSize;
61     };
62
63     // https://msdn.microsoft.com/en-us/library/windows/desktop/ms684946(v=vs.85).aspx
64     constexpr const size_t minNumberOfEntries = 16;
65     constexpr const size_t sizeOfBufferOnStack = sizeof(PSAPI_WORKING_SET_INFORMATION) + minNumberOfEntries * sizeof(PSAPI_WORKING_SET_BLOCK);
66     std::aligned_storage<sizeOfBufferOnStack, alignof(PSAPI_WORKING_SET_INFORMATION)>::type bufferOnStack;
67     auto* workingSetsOnStack = reinterpret_cast<PSAPI_WORKING_SET_INFORMATION*>(&bufferOnStack);
68     if (QueryWorkingSet(process.get(), workingSetsOnStack, sizeOfBufferOnStack))
69         return countSizeOfPrivateWorkingSet(*workingSetsOnStack);
70
71     auto updateNumberOfEntries = [&] (size_t numberOfEntries) {
72         // If working set increases between first QueryWorkingSet and second QueryWorkingSet, the second one can fail.
73         // At that time, we should increase numberOfEntries.
74         return std::max(minNumberOfEntries, numberOfEntries + numberOfEntries / 4 + 1);
75     };
76
77     for (size_t numberOfEntries = updateNumberOfEntries(workingSetsOnStack->NumberOfEntries);;) {
78         size_t workingSetSizeInBytes = sizeof(PSAPI_WORKING_SET_INFORMATION) + sizeof(PSAPI_WORKING_SET_BLOCK) * numberOfEntries;
79         auto workingSets = MallocPtr<PSAPI_WORKING_SET_INFORMATION>::malloc(workingSetSizeInBytes);
80         if (QueryWorkingSet(process.get(), workingSets.get(), workingSetSizeInBytes))
81             return countSizeOfPrivateWorkingSet(*workingSets);
82
83         if (GetLastError() != ERROR_BAD_LENGTH)
84             return 0;
85         numberOfEntries = updateNumberOfEntries(workingSets->NumberOfEntries);
86     }
87 }
88
89 }