Libraries: Move to Userland/Libraries/

Userland/Libraries/LibThread/BackgroundAction.cpp

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@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/Queue.h>
+#include <LibThread/BackgroundAction.h>
+#include <LibThread/Lock.h>
+#include <LibThread/Thread.h>
+
+static LibThread::Lockable<Queue<Function<void()>>>* s_all_actions;
+static LibThread::Thread* s_background_thread;
+
+static int background_thread_func()
+{
+    while (true) {
+        Function<void()> work_item;
+        {
+            LOCKER(s_all_actions->lock());
+
+            if (!s_all_actions->resource().is_empty())
+                work_item = s_all_actions->resource().dequeue();
+        }
+        if (work_item)
+            work_item();
+        else
+            sleep(1);
+    }
+
+    ASSERT_NOT_REACHED();
+}
+
+static void init()
+{
+    s_all_actions = new LibThread::Lockable<Queue<Function<void()>>>();
+    s_background_thread = &LibThread::Thread::construct(background_thread_func).leak_ref();
+    s_background_thread->set_name("Background thread");
+    s_background_thread->start();
+}
+
+LibThread::Lockable<Queue<Function<void()>>>& LibThread::BackgroundActionBase::all_actions()
+{
+    if (s_all_actions == nullptr)
+        init();
+    return *s_all_actions;
+}
+
+LibThread::Thread& LibThread::BackgroundActionBase::background_thread()
+{
+    if (s_background_thread == nullptr)
+        init();
+    return *s_background_thread;
+}

Userland/Libraries/LibThread/BackgroundAction.h

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@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 <AK/Function.h>
+#include <AK/NonnullRefPtr.h>
+#include <AK/Optional.h>
+#include <AK/Queue.h>
+#include <LibCore/Event.h>
+#include <LibCore/EventLoop.h>
+#include <LibCore/Object.h>
+#include <LibThread/Lock.h>
+#include <LibThread/Thread.h>
+
+namespace LibThread {
+
+template<typename Result>
+class BackgroundAction;
+
+class BackgroundActionBase {
+    template<typename Result>
+    friend class BackgroundAction;
+
+private:
+    BackgroundActionBase() { }
+
+    static Lockable<Queue<Function<void()>>>& all_actions();
+    static Thread& background_thread();
+};
+
+template<typename Result>
+class BackgroundAction final : public Core::Object
+    , private BackgroundActionBase {
+    C_OBJECT(BackgroundAction);
+
+public:
+    static NonnullRefPtr<BackgroundAction<Result>> create(
+        Function<Result()> action,
+        Function<void(Result)> on_complete = nullptr)
+    {
+        return adopt(*new BackgroundAction(move(action), move(on_complete)));
+    }
+
+    virtual ~BackgroundAction() { }
+
+private:
+    BackgroundAction(Function<Result()> action, Function<void(Result)> on_complete)
+        : Core::Object(&background_thread())
+        , m_action(move(action))
+        , m_on_complete(move(on_complete))
+    {
+        LOCKER(all_actions().lock());
+
+        all_actions().resource().enqueue([this] {
+            m_result = m_action();
+            if (m_on_complete) {
+                Core::EventLoop::current().post_event(*this, make<Core::DeferredInvocationEvent>([this](auto&) {
+                    m_on_complete(m_result.release_value());
+                    this->remove_from_parent();
+                }));
+                Core::EventLoop::wake();
+            } else {
+                this->remove_from_parent();
+            }
+        });
+    }
+
+    Function<Result()> m_action;
+    Function<void(Result)> m_on_complete;
+    Optional<Result> m_result;
+};
+
+}

Userland/Libraries/LibThread/CMakeLists.txt

@@ -0,0 +1,7 @@
+set(SOURCES
+    BackgroundAction.cpp
+    Thread.cpp
+)
+
+serenity_lib(LibThread thread)
+target_link_libraries(LibThread LibC LibCore LibPthread)

Userland/Libraries/LibThread/Lock.h

@@ -0,0 +1,140 @@
+/*
+ * Copyright (c) 2018-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
+
+#ifdef __serenity__
+
+#    include <AK/Assertions.h>
+#    include <AK/Atomic.h>
+#    include <AK/Types.h>
+#    include <unistd.h>
+
+namespace LibThread {
+
+class Lock {
+public:
+    Lock() { }
+    ~Lock() { }
+
+    void lock();
+    void unlock();
+
+private:
+    Atomic<pid_t> m_holder { 0 };
+    u32 m_level { 0 };
+};
+
+class Locker {
+public:
+    ALWAYS_INLINE explicit Locker(Lock& l)
+        : m_lock(l)
+    {
+        lock();
+    }
+    ALWAYS_INLINE ~Locker() { unlock(); }
+    ALWAYS_INLINE void unlock() { m_lock.unlock(); }
+    ALWAYS_INLINE void lock() { m_lock.lock(); }
+
+private:
+    Lock& m_lock;
+};
+
+ALWAYS_INLINE void Lock::lock()
+{
+    pid_t tid = gettid();
+    if (m_holder == tid) {
+        ++m_level;
+        return;
+    }
+    for (;;) {
+        int expected = 0;
+        if (m_holder.compare_exchange_strong(expected, tid, AK::memory_order_acq_rel)) {
+            m_level = 1;
+            return;
+        }
+        donate(expected);
+    }
+}
+
+inline void Lock::unlock()
+{
+    ASSERT(m_holder == gettid());
+    ASSERT(m_level);
+    if (m_level == 1)
+        m_holder.store(0, AK::memory_order_release);
+    else
+        --m_level;
+}
+
+#    define LOCKER(lock) LibThread::Locker locker(lock)
+
+template<typename T>
+class Lockable {
+public:
+    Lockable() { }
+
+    template<typename... Args>
+    Lockable(Args&&... args)
+        : m_resource(forward(args)...)
+    {
+    }
+
+    Lockable(T&& resource)
+        : m_resource(move(resource))
+    {
+    }
+    Lock& lock() { return m_lock; }
+    T& resource() { return m_resource; }
+
+    T lock_and_copy()
+    {
+        LOCKER(m_lock);
+        return m_resource;
+    }
+
+private:
+    T m_resource;
+    Lock m_lock;
+};
+
+}
+
+#else
+
+namespace LibThread {
+
+class Lock {
+public:
+    Lock() { }
+    ~Lock() { }
+};
+
+}
+
+#    define LOCKER(x)
+
+#endif

Userland/Libraries/LibThread/Thread.cpp

@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@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 <LibThread/Thread.h>
+#include <pthread.h>
+#include <string.h>
+#include <unistd.h>
+
+LibThread::Thread::Thread(Function<int()> action, StringView thread_name)
+    : Core::Object(nullptr)
+    , m_action(move(action))
+    , m_thread_name(thread_name.is_null() ? "" : thread_name)
+{
+    register_property("thread_name", [&] { return JsonValue { m_thread_name }; });
+    register_property("tid", [&] { return JsonValue { m_tid }; });
+}
+
+LibThread::Thread::~Thread()
+{
+    if (m_tid) {
+        dbgln("Destroying thread \"{}\"({}) while it is still running!", m_thread_name, m_tid);
+        [[maybe_unused]] auto res = join();
+    }
+}
+
+void LibThread::Thread::start()
+{
+    int rc = pthread_create(
+        &m_tid,
+        nullptr,
+        [](void* arg) -> void* {
+            Thread* self = static_cast<Thread*>(arg);
+            int exit_code = self->m_action();
+            self->m_tid = 0;
+            return (void*)exit_code;
+        },
+        static_cast<void*>(this));
+
+    ASSERT(rc == 0);
+    if (!m_thread_name.is_empty()) {
+        rc = pthread_setname_np(m_tid, m_thread_name.characters());
+        ASSERT(rc == 0);
+    }
+    dbgln("Started thread \"{}\", tid = {}", m_thread_name, m_tid);
+}

Userland/Libraries/LibThread/Thread.h

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@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 <AK/DistinctNumeric.h>
+#include <AK/Function.h>
+#include <AK/Result.h>
+#include <AK/String.h>
+#include <LibCore/Object.h>
+#include <pthread.h>
+
+namespace LibThread {
+
+TYPEDEF_DISTINCT_ORDERED_ID(int, ThreadError);
+
+class Thread final : public Core::Object {
+    C_OBJECT(Thread);
+
+public:
+    virtual ~Thread();
+
+    void start();
+
+    template<typename T = void>
+    Result<T, ThreadError> join();
+
+    String thread_name() const { return m_thread_name; }
+    pthread_t tid() const { return m_tid; }
+
+private:
+    explicit Thread(Function<int()> action, StringView thread_name = nullptr);
+    Function<int()> m_action;
+    pthread_t m_tid { 0 };
+    String m_thread_name;
+};
+
+template<typename T>
+Result<T, ThreadError> Thread::join()
+{
+    void* thread_return = nullptr;
+    int rc = pthread_join(m_tid, &thread_return);
+    if (rc != 0) {
+        return ThreadError { rc };
+    }
+
+    m_tid = 0;
+    if constexpr (IsVoid<T>::value)
+        return {};
+    else
+        return { static_cast<T>(thread_return) };
+}
+
+}