Atmosphere/libraries/libmesosphere/source/kern_k_interrupt_task_manager.cpp

/*
 * Copyright (c) 2018-2020 Atmosphère-NX
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include <mesosphere.hpp>

namespace ams::kern {

    void KInterruptTaskManager::TaskQueue::Enqueue(KInterruptTask *task) {
        MESOSPHERE_ASSERT(task != m_head);
        MESOSPHERE_ASSERT(task != m_tail);
        MESOSPHERE_AUDIT(task->GetNextTask() == nullptr);

        /* Insert the task into the queue. */
        if (m_tail != nullptr) {
            m_tail->SetNextTask(task);
        } else {
            m_head = task;
        }

        m_tail = task;

        /* Set the next task for auditing. */
        #if defined (MESOSPHERE_BUILD_FOR_AUDITING)
        task->SetNextTask(GetDummyInterruptTask());
        #endif
    }

    void KInterruptTaskManager::TaskQueue::Dequeue() {
        MESOSPHERE_ASSERT(m_head != nullptr);
        MESOSPHERE_ASSERT(m_tail != nullptr);
        MESOSPHERE_AUDIT(m_tail->GetNextTask() == GetDummyInterruptTask());

        /* Pop the task from the front of the queue. */
        KInterruptTask *old_head = m_head;

        if (m_head == m_tail) {
            m_head = nullptr;
            m_tail = nullptr;
        } else {
            m_head = m_head->GetNextTask();
        }

        #if defined (MESOSPHERE_BUILD_FOR_AUDITING)
        old_head->SetNextTask(nullptr);
        #else
        AMS_UNUSED(old_head);
        #endif
    }

    void KInterruptTaskManager::ThreadFunction(uintptr_t arg) {
        reinterpret_cast<KInterruptTaskManager *>(arg)->ThreadFunctionImpl();
    }

    void KInterruptTaskManager::ThreadFunctionImpl() {
        MESOSPHERE_ASSERT_THIS();

        while (true) {
            /* Get a task. */
            KInterruptTask *task = nullptr;
            {
                KScopedInterruptDisable di;

                task = m_task_queue.GetHead();
                if (task == nullptr) {
                    m_thread->SetState(KThread::ThreadState_Waiting);
                    continue;
                }

                m_task_queue.Dequeue();
            }

            /* Do the task. */
            task->DoTask();

            /* Destroy any objects we may need to close. */
            m_thread->DestroyClosedObjects();
        }
    }

    void KInterruptTaskManager::Initialize() {
        /* Reserve a thread from the system limit. */
        MESOSPHERE_ABORT_UNLESS(Kernel::GetSystemResourceLimit().Reserve(ams::svc::LimitableResource_ThreadCountMax, 1));

        /* Create and initialize the thread. */
        m_thread = KThread::Create();
        MESOSPHERE_ABORT_UNLESS(m_thread != nullptr);
        MESOSPHERE_R_ABORT_UNLESS(KThread::InitializeHighPriorityThread(m_thread, ThreadFunction, reinterpret_cast<uintptr_t>(this)));
        KThread::Register(m_thread);

        /* Run the thread. */
        m_thread->Run();
    }

    void KInterruptTaskManager::EnqueueTask(KInterruptTask *task) {
        MESOSPHERE_ASSERT(!KInterruptManager::AreInterruptsEnabled());

        /* Enqueue the task and signal the scheduler. */
        m_task_queue.Enqueue(task);
        Kernel::GetScheduler().SetInterruptTaskRunnable();
    }

}