Implement memory monitoring functions for Linux OS
[WebKit-https.git] / Source / WTF / wtf / linux / ProcessMemoryFootprint.h
1 /*
2  * Copyright (C) 2019 Metrological Group B.V.
3  * Copyright (C) 2019 Igalia S.L.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #if OS(LINUX)
30
31 #include <sys/resource.h>
32 #include <wtf/linux/CurrentProcessMemoryStatus.h>
33
34 struct ProcessMemoryFootprint {
35     uint64_t current;
36     uint64_t peak;
37
38     static ProcessMemoryFootprint now()
39     {
40         struct rusage ru;
41         getrusage(RUSAGE_SELF, &ru);
42
43         ProcessMemoryStatus ps;
44         currentProcessMemoryStatus(ps);
45
46         return { ps.resident, static_cast<uint64_t>(ru.ru_maxrss) * 1024 };
47     }
48
49     static void resetPeak()
50     {
51         // To reset the peak size, we need to write 5 to /proc/self/clear_refs
52         // as described in `man -s5 proc`, in the clear_refs section.
53         // Only available since 4.0.
54         FILE* f = fopen("/proc/self/clear_refs", "w");
55         if (!f)
56             return;
57         fwrite("5", 1, 1, f);
58         fclose(f);
59     }
60 };
61
62 #endif