Kernel: Start working on a syscall for logging performance events

This patch introduces sys$perf_event() with two event types:

- PERF_EVENT_MALLOC
- PERF_EVENT_FREE

After the first call to sys$perf_event(), a process will begin keeping
these events in a buffer. When the process dies, that buffer will be
written out to "perfcore" in the current directory unless that filename
is already taken.

This is probably not the best way to do this, but it's a start and will
make it possible to start doing memory allocation profiling. :^)

Kernel/Makefile

@@ -75,6 +75,7 @@ OBJS = \
     PCI/IOAccess.o \
     PCI/MMIOAccess.o \
     PCI/Initializer.o \
+    PerformanceEventBuffer.o \
     Process.o \
     ProcessTracer.o \
     Profiling.o \

Kernel/PerformanceEventBuffer.cpp

@@ -0,0 +1,126 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
+ * 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 documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <AK/JsonArraySerializer.h>
+#include <AK/JsonObjectSerializer.h>
+#include <Kernel/KBufferBuilder.h>
+#include <Kernel/PerformanceEventBuffer.h>
+
+PerformanceEventBuffer::PerformanceEventBuffer()
+    : m_buffer(KBuffer::create_with_size(4 * MB))
+{
+}
+
+KResult PerformanceEventBuffer::append(int type, uintptr_t arg1, uintptr_t arg2)
+{
+    if (count() >= capacity())
+        return KResult(-ENOBUFS);
+
+    PerformanceEvent event;
+    event.type = type;
+
+    switch (type) {
+    case PERF_EVENT_MALLOC:
+        event.data.malloc.size = arg1;
+        event.data.malloc.ptr = arg2;
+#ifdef VERY_DEBUG
+        dbg() << "PERF_EVENT_MALLOC: " << (void*)event.data.malloc.ptr << " (" << event.data.malloc.size << ")";
+#endif
+        break;
+    case PERF_EVENT_FREE:
+        event.data.free.ptr = arg1;
+#ifdef VERY_DEBUG
+        dbg() << "PERF_EVENT_FREE: " << (void*)event.data.free.ptr;
+#endif
+        break;
+    default:
+        return KResult(-EINVAL);
+    }
+
+    uintptr_t ebp;
+    asm volatile("movl %%ebp, %%eax"
+                 : "=a"(ebp));
+    //copy_from_user(&ebp, (uintptr_t*)current->get_register_dump_from_stack().ebp);
+    Vector<uintptr_t> backtrace;
+    {
+        SmapDisabler disabler;
+        backtrace = current->raw_backtrace(ebp);
+    }
+    event.stack_size = min(sizeof(event.stack) / sizeof(uintptr_t), static_cast<size_t>(backtrace.size()));
+    memcpy(event.stack, backtrace.data(), event.stack_size * sizeof(uintptr_t));
+
+#ifdef VERY_DEBUG
+    for (size_t i = 0; i < event.stack_size; ++i)
+        dbg() << "    " << (void*)event.stack[i];
+#endif
+
+    event.timestamp = g_uptime;
+    at(m_count++) = event;
+    return KSuccess;
+}
+
+PerformanceEvent& PerformanceEventBuffer::at(size_t index)
+{
+    ASSERT(index < capacity());
+    auto* events = reinterpret_cast<PerformanceEvent*>(m_buffer.data());
+    return events[index];
+}
+
+KBuffer PerformanceEventBuffer::to_json(pid_t pid, const String& executable_path) const
+{
+    KBufferBuilder builder;
+
+    JsonObjectSerializer object(builder);
+    object.add("pid", pid);
+    object.add("executable", executable_path);
+
+    auto array = object.add_array("events");
+    for (size_t i = 0; i < m_count; ++i) {
+        auto& event = at(i);
+        auto object = array.add_object();
+        switch (event.type) {
+        case PERF_EVENT_MALLOC:
+            object.add("type", "malloc");
+            object.add("ptr", static_cast<u64>(event.data.malloc.ptr));
+            object.add("size", static_cast<u64>(event.data.malloc.size));
+            break;
+        case PERF_EVENT_FREE:
+            object.add("type", "free");
+            object.add("ptr", static_cast<u64>(event.data.free.ptr));
+            break;
+        }
+        object.add("timestamp", event.timestamp);
+        auto stack_array = object.add_array("stack");
+        for (size_t j = 0; j < event.stack_size; ++j) {
+            stack_array.add(event.stack[j]);
+        }
+        stack_array.finish();
+        object.finish();
+    }
+    array.finish();
+    object.finish();
+    return builder.build();
+}

Kernel/PerformanceEventBuffer.h

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
+ * 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 documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <Kernel/KBuffer.h>
+#include <Kernel/KResult.h>
+
+struct [[gnu::packed]] MallocPerformanceEvent {
+    size_t size;
+    uintptr_t ptr;
+};
+
+struct [[gnu::packed]] FreePerformanceEvent {
+    size_t size;
+    uintptr_t ptr;
+};
+
+struct [[gnu::packed]] PerformanceEvent {
+    u8 type { 0 };
+    u8 stack_size { 0 };
+    u64 timestamp;
+    union {
+        MallocPerformanceEvent malloc;
+        FreePerformanceEvent free;
+    } data;
+    uintptr_t stack[32];
+};
+
+class PerformanceEventBuffer {
+public:
+    PerformanceEventBuffer();
+
+    KResult append(int type, uintptr_t arg1, uintptr_t arg2);
+
+    size_t capacity() const { return m_buffer.size() / sizeof(PerformanceEvent); }
+    size_t count() const { return m_count; }
+    const PerformanceEvent& at(size_t index) const
+    {
+        return const_cast<PerformanceEventBuffer&>(*this).at(index);
+    }
+
+    KBuffer to_json(pid_t, const String& executable_path) const;
+
+private:
+    PerformanceEvent& at(size_t index);
+
+    size_t m_count { 0 };
+    KBuffer m_buffer;
+};

Kernel/Process.cpp

@@ -2940,6 +2940,15 @@ void Process::finalize()
     dbg() << "Finalizing process " << *this;
 #endif
 
+    if (m_perf_event_buffer) {
+        auto description_or_error = VFS::the().open("perfcore", O_CREAT | O_EXCL, 0400, current_directory(), UidAndGid { m_uid, m_gid });
+        if (!description_or_error.is_error()) {
+            auto& description = description_or_error.value();
+            auto json = m_perf_event_buffer->to_json(m_pid, m_executable ? m_executable->absolute_path() : "");
+            description->write(json.data(), json.size());
+        }
+    }
+
     m_fds.clear();
     m_tty = nullptr;
     m_executable = nullptr;
@@ -4670,3 +4679,10 @@ int Process::sys$unveil(const Syscall::SC_unveil_params* user_params)
     m_veil_state = VeilState::Dropped;
     return 0;
 }
+
+int Process::sys$perf_event(int type, uintptr_t arg1, uintptr_t arg2)
+{
+    if (!m_perf_event_buffer)
+        m_perf_event_buffer = make<PerformanceEventBuffer>();
+    return m_perf_event_buffer->append(type, arg1, arg2);
+}

Kernel/Process.h

@@ -35,6 +35,7 @@
 #include <AK/Weakable.h>
 #include <Kernel/FileSystem/VirtualFileSystem.h>
 #include <Kernel/Lock.h>
+#include <Kernel/PerformanceEventBuffer.h>
 #include <Kernel/Syscall.h>
 #include <Kernel/TTY/TTY.h>
 #include <Kernel/Thread.h>
@@ -301,6 +302,7 @@ public:
     int sys$chroot(const char* path, size_t path_length, int mount_flags);
     int sys$pledge(const Syscall::SC_pledge_params*);
     int sys$unveil(const Syscall::SC_unveil_params*);
+    int sys$perf_event(int type, uintptr_t arg1, uintptr_t arg2);
 
     template<bool sockname, typename Params>
     int get_sock_or_peer_name(const Params&);
@@ -511,6 +513,8 @@ private:
 
     WaitQueue& futex_queue(i32*);
     HashMap<u32, OwnPtr<WaitQueue>> m_futex_queues;
+
+    OwnPtr<PerformanceEventBuffer> m_perf_event_buffer;
 };
 
 class ProcessInspectionHandle {

Kernel/Syscall.h

@@ -175,7 +175,8 @@ typedef u32 socklen_t;
     __ENUMERATE_SYSCALL(set_process_boost)          \
     __ENUMERATE_SYSCALL(chroot)                     \
     __ENUMERATE_SYSCALL(pledge)                     \
-    __ENUMERATE_SYSCALL(unveil)
+    __ENUMERATE_SYSCALL(unveil)                     \
+    __ENUMERATE_SYSCALL(perf_event)
 
 namespace Syscall {
 

Kernel/UnixTypes.h

@@ -28,6 +28,9 @@
 
 #include <AK/Types.h>
 
+#define PERF_EVENT_MALLOC 1
+#define PERF_EVENT_FREE 2
+
 #define WNOHANG 1
 #define WUNTRACED 2
 #define WSTOPPED WUNTRACED