Files
jsix/src/kernel/objects/process.h
Justin C. Miller d3c1d6cc34 [kernel] Add debug names to processes
To make debugging easier, add names to processes. These are arbitrary
and supplied by the caller of process_create. The max is 31 characters
in debug configuration, and 0 in release.
2024-08-12 19:40:20 -07:00

133 lines
3.9 KiB
C++

#pragma once
/// \file process.h
/// Definition of process kobject types
#include <j6/cap_flags.h>
#include <util/node_map.h>
#include <util/vector.h>
#include "heap_allocator.h"
#include "objects/kobject.h"
#include "page_table.h"
#include "vm_space.h"
namespace obj {
static constexpr bool __use_process_names =
#ifdef __jsix_config_debug
true;
#else
false;
#endif
class process :
public kobject
{
public:
/// Capabilities on a newly constructed process handle
static constexpr j6_cap_t creation_caps = j6_cap_process_all;
/// Top of memory area where thread stacks are allocated
static constexpr uintptr_t stacks_top = 0x0000800000000000;
/// Size of userspace thread stacks
static constexpr size_t stack_size = 0x4000000; // 64MiB
/// Value that represents default priority
static constexpr uint8_t default_priority = 0xff;
static constexpr kobject::type type = kobject::type::process;
/// Constructor.
process(const char *name);
/// Destructor.
virtual ~process();
/// Get the currently executing process.
static process & current();
/// Terminate this process.
/// \arg code The return code to exit with.
void exit(int64_t code);
/// Get the process' virtual memory space
vm_space & space() { return m_space; }
/// Get the debugging name of the process
const char *name() { if constexpr(__use_process_names) return m_name; else return nullptr; }
/// Create a new thread in this process
/// \args rsp3 If non-zero, sets the ring3 stack pointer to this value
/// \args priority The new thread's scheduling priority
/// \returns The newly created thread object
thread * create_thread(uintptr_t rsp3 = 0, uint8_t priorty = default_priority);
/// Give this process access to an object capability handle
/// \args handle A handle to give this process access to
void add_handle(j6_handle_t handle);
/// Remove access to an object capability from this process
/// \args handle The handle that refers to the object
/// \returns True if the handle was removed
bool remove_handle(j6_handle_t handle);
/// Return whether this process has access to the given object capability
/// \args handle The handle to the capability
/// \returns True if the process has been given access to that capability
bool has_handle(j6_handle_t handle);
/// Get the list of handle ids this process owns
/// \arg handles Pointer to an array of handles descriptors to copy into
/// \arg len Size of the array
/// \returns Total number of handles (may be more than number copied)
size_t list_handles(j6_handle_descriptor *handles, size_t len);
/// Inform the process of an exited thread
/// \args th The thread which has exited
void thread_exited(thread *th);
/// Get the process object that owns kernel threads and the
/// kernel address space
static process & kernel_process();
/// Create the special kernel process that owns kernel tasks
/// \arg pml4 The kernel-only pml4
/// \returns The kernel process object
static process * create_kernel_process(page_table *pml4);
protected:
/// Don't delete a process on no handles, the scheduler takes
/// care of that.
virtual void on_no_handles() override {}
private:
// This constructor is called by create_kernel_process
process(page_table *kpml4);
int64_t m_return_code;
vm_space m_space;
util::vector<thread*> m_threads;
util::spinlock m_threads_lock;
util::node_set<j6_handle_t, j6_handle_invalid, heap_allocated> m_handles;
util::spinlock m_handles_lock;
enum class state : uint8_t { running, exited };
state m_state;
static constexpr size_t max_name_len =
#ifdef __jsix_config_debug
32;
#else
0;
#endif
char m_name[max_name_len];
};
} // namespace obj