MaxOS::processes::resources::ThreadResource Class Reference

A wrapper for a Thread which exposes Thread operations as Resource operations. More...

#include <scheduler_resources.h>

Inheritance diagram for MaxOS::processes::resources::ThreadResource:

Public Member Functions
	ThreadResource (const string &name, size_t flags, resource_type_t type)
void	close (size_t flags) final
	Closes the thread resource, marking the thread to be removed by the scheduler.
int	read (void *buffer, size_t size, size_t flags) final
	Reads data from the thread resource.
int	write (const void *buffer, size_t size, size_t flags) final
	Writes data to the thread resource.

Public Attributes
Thread *	thread
	The thread that this resource handles & exposes.
uint64_t	exit_code
	The exit code of the thread once it has exited.

Detailed Description

A wrapper for a Thread which exposes Thread operations as Resource operations.

See also

Thread

Resource

Note

The thread pointer will be freed by scheduler during close()

Definition at line 59 of file scheduler_resources.h.

Constructor & Destructor Documentation

ThreadResource()

ThreadResource::ThreadResource	(	const string &	name,
		size_t	flags,
		resource_type_t	type
	)

Definition at line 179 of file scheduler_resources.cpp.

: Resource(name, flags, type)
{
 
}

Member Function Documentation

close()

void ThreadResource::close ( size_t  flags )

final

Closes the thread resource, marking the thread to be removed by the scheduler.

Parameters

flags

N/A

Definition at line 190 of file scheduler_resources.cpp.

                                       {
 
    thread->thread_state = ThreadState::STOPPED;
}

References thread, and MaxOS::processes::Thread::thread_state.

read()

int ThreadResource::read ( void *  buffer, size_t  size, size_t  flags  )

final

Reads data from the thread resource.

Parameters

buffer	The buffer to read into
size	The number of bytes to read
flags	The flags to pass to the reading

Returns

The number of bytes successfully read or -1 on error

Definition at line 204 of file scheduler_resources.cpp.

                                                                {
 
    // Thread not found
    if(!thread && flags != (size_t)ThreadFlags::READ_STATS)
        return -1;
 
    switch ((ThreadFlags)flags) {
 
        case ThreadFlags::READ_STATS: {
 
            // Check bounds
            if(size < sizeof(thread_stats_t))
                return -1;
 
            // Get the info
            thread_stats_t stats = {};
 
            if(thread) {
                stats.tid = thread->tid;
                stats.pid = thread->parent_pid;
                stats.ticks = thread->ticks;
                stats.state = (size_t)thread->thread_state;
                stats.wakeup_time_ms = thread->wakeup_time;
            }
            stats.exit_code = exit_code;
 
            // Copy across
            memcpy(buffer, &stats, sizeof(thread_stats_t));
            return sizeof(thread_stats_t);
 
        }
 
        default:
            return -1;
 
    }
 
}

References exit_code, MaxOS::processes::Thread::parent_pid, thread, MaxOS::processes::Thread::thread_state, MaxOS::processes::Thread::ticks, MaxOS::processes::Thread::tid, and MaxOS::processes::Thread::wakeup_time.

write()

int ThreadResource::write ( const void *  buffer, size_t  size, size_t  flags  )

final

Writes data to the thread resource.

Parameters

buffer	The buffer to write from
size	The number of bytes to write
flags	The flags to pass to the writing

Returns

The number of bytes successfully written or -1 on error

Definition at line 252 of file scheduler_resources.cpp.

                                                                       {
 
    // Thread not found
    if(!thread)
        return -1;
 
    switch ((ThreadFlags)flags) {
 
        case ThreadFlags::WRITE_SLEEP_TIME: {
 
            // Set the sleep time
            uint64_t sleep_time = *((uint64_t*)buffer);
            thread->sleep(sleep_time);
            return size;
        }
 
        case ThreadFlags::WRITE_KILL: {
 
            // Kill the thread
            exit_code = *((uint64_t*)buffer);
            thread->thread_state = ThreadState::STOPPED;
            thread->yield();
            return size;
        }
 
        case ThreadFlags::WRITE_YIELD: {
            thread->yield();
            return size;
        }
 
        case ThreadFlags::WRITE_ENABLE_PORT_IO: {
            uint64_t port = *((uint64_t*)buffer);
            thread->enable_port(port);
            return size;
        }
 
        case ThreadFlags::WRITE_DISABLE_PORT_IO: {
            uint64_t port = *((uint64_t*)buffer);
            thread->disable_port(port);
            return size;
        }
 
        default:
            return -1;
    }
 
}

References MaxOS::processes::Thread::disable_port(), MaxOS::processes::Thread::enable_port(), exit_code, MaxOS::processes::Thread::sleep(), thread, MaxOS::processes::Thread::thread_state, and MaxOS::processes::Thread::yield().

Member Data Documentation

exit_code

uint64_t MaxOS::processes::resources::ThreadResource::exit_code

The exit code of the thread once it has exited.

Definition at line 66 of file scheduler_resources.h.

Referenced by read(), and write().

thread

Thread* MaxOS::processes::resources::ThreadResource::thread

The thread that this resource handles & exposes.

Definition at line 65 of file scheduler_resources.h.

Referenced by close(), read(), and write().

---

The documentation for this class was generated from the following files:

• /home/runner/work/MaxOS/MaxOS/kernel/include/processes/resources/scheduler_resources.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/processes/resources/scheduler_resources.cpp