forked from haiwan/sledge
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
335 lines
12 KiB
335 lines
12 KiB
#pragma once
|
|
|
|
#include <ucontext.h>
|
|
#include <uv.h>
|
|
#include <stdbool.h>
|
|
#include "sandbox_request.h"
|
|
|
|
#include "arch/context.h"
|
|
#include "deque.h"
|
|
#include "http_request.h"
|
|
#include "http_response.h"
|
|
#include "module.h"
|
|
#include "ps_list.h"
|
|
#include "software_interrupt.h"
|
|
|
|
/*********************
|
|
* Structs and Types *
|
|
********************/
|
|
|
|
struct sandbox_io_handle {
|
|
int file_descriptor;
|
|
union uv_any_handle libuv_handle;
|
|
};
|
|
|
|
typedef enum
|
|
{
|
|
SANDBOX_UNINITIALIZED = 0, /* Assumption: mmap zeros out structure */
|
|
SANDBOX_ALLOCATED,
|
|
SANDBOX_SET_AS_INITIALIZED,
|
|
SANDBOX_INITIALIZED,
|
|
SANDBOX_SET_AS_RUNNABLE,
|
|
SANDBOX_RUNNABLE,
|
|
SANDBOX_SET_AS_RUNNING,
|
|
SANDBOX_RUNNING,
|
|
SANDBOX_SET_AS_PREEMPTED,
|
|
SANDBOX_PREEMPTED,
|
|
SANDBOX_SET_AS_BLOCKED,
|
|
SANDBOX_BLOCKED,
|
|
SANDBOX_SET_AS_RETURNED,
|
|
SANDBOX_RETURNED,
|
|
SANDBOX_SET_AS_COMPLETE,
|
|
SANDBOX_COMPLETE,
|
|
SANDBOX_SET_AS_ERROR,
|
|
SANDBOX_ERROR,
|
|
SANDBOX_STATE_COUNT
|
|
} sandbox_state_t;
|
|
|
|
struct sandbox {
|
|
sandbox_state_t state;
|
|
|
|
uint32_t sandbox_size; /* The struct plus enough buffer to hold the request or response (sized off largest) */
|
|
|
|
void * linear_memory_start; /* after sandbox struct */
|
|
uint32_t linear_memory_size; /* from after sandbox struct */
|
|
uint64_t linear_memory_max_size;
|
|
|
|
void * stack_start;
|
|
uint32_t stack_size;
|
|
|
|
struct arch_context ctxt; /* register context for context switch. */
|
|
|
|
uint64_t request_arrival_timestamp; /* Timestamp when request is received */
|
|
uint64_t allocation_timestamp; /* Timestamp when sandbox is allocated */
|
|
uint64_t response_timestamp; /* Timestamp when response is sent */
|
|
uint64_t completion_timestamp; /* Timestamp when sandbox runs to completion */
|
|
uint64_t last_state_change_timestamp; /* Used for bookkeeping of actual execution time */
|
|
|
|
/* Duration of time (in cycles) that the sandbox is in each state */
|
|
uint64_t initializing_duration;
|
|
uint64_t runnable_duration;
|
|
uint64_t preempted_duration;
|
|
uint64_t running_duration;
|
|
uint64_t blocked_duration;
|
|
uint64_t returned_duration;
|
|
|
|
uint64_t absolute_deadline;
|
|
uint64_t total_time; /* From Request to Response */
|
|
|
|
struct module *module; /* the module this is an instance of */
|
|
|
|
int32_t arguments_offset; /* actual placement of arguments in the sandbox. */
|
|
void * arguments; /* arguments from request, must be of module->argument_count size. */
|
|
int32_t return_value;
|
|
|
|
struct sandbox_io_handle io_handles[SANDBOX_MAX_IO_HANDLE_COUNT];
|
|
struct sockaddr client_address; /* client requesting connection! */
|
|
int client_socket_descriptor;
|
|
uv_tcp_t client_libuv_stream;
|
|
uv_shutdown_t client_libuv_shutdown_request;
|
|
|
|
http_parser http_parser;
|
|
struct http_request http_request;
|
|
struct http_response http_response;
|
|
|
|
char * read_buffer;
|
|
ssize_t read_length, read_size;
|
|
|
|
/* Used for the scheduling runqueue as an in-place linked list data structure. */
|
|
/* The variable name "list" is used for ps_list's default name-based MACROS. */
|
|
struct ps_list list;
|
|
|
|
/*
|
|
* The length of the HTTP Request.
|
|
* This acts as an offset to the STDOUT of the Sandbox
|
|
*/
|
|
ssize_t request_length;
|
|
|
|
ssize_t request_response_data_length; /* Should be <= module->max_request_or_response_size */
|
|
char request_response_data[1]; /* of request_response_data_length, following sandbox mem.. */
|
|
} PAGE_ALIGNED;
|
|
|
|
/***************************
|
|
* Externs *
|
|
**************************/
|
|
|
|
extern void worker_thread_block_current_sandbox(void);
|
|
extern void worker_thread_on_sandbox_exit(struct sandbox *sandbox);
|
|
extern void worker_thread_process_io(void);
|
|
extern void worker_thread_wakeup_sandbox(struct sandbox *sandbox);
|
|
|
|
/***************************
|
|
* Public API *
|
|
**************************/
|
|
|
|
struct sandbox *sandbox_allocate(struct sandbox_request *sandbox_request);
|
|
void sandbox_free(struct sandbox *sandbox);
|
|
void sandbox_free_linear_memory(struct sandbox *sandbox);
|
|
void sandbox_main(struct sandbox *sandbox);
|
|
int sandbox_parse_http_request(struct sandbox *sandbox, size_t length);
|
|
|
|
static inline char *
|
|
sandbox_state_stringify(sandbox_state_t state)
|
|
{
|
|
switch (state) {
|
|
case SANDBOX_UNINITIALIZED:
|
|
return "Uninitialized";
|
|
case SANDBOX_ALLOCATED:
|
|
return "Allocated";
|
|
case SANDBOX_SET_AS_INITIALIZED:
|
|
return "Set As Initialized";
|
|
case SANDBOX_INITIALIZED:
|
|
return "Initialized";
|
|
case SANDBOX_SET_AS_RUNNABLE:
|
|
return "Set As Runnable";
|
|
case SANDBOX_RUNNABLE:
|
|
return "Runnable";
|
|
case SANDBOX_SET_AS_RUNNING:
|
|
return "Set As Running";
|
|
case SANDBOX_RUNNING:
|
|
return "Running";
|
|
case SANDBOX_SET_AS_PREEMPTED:
|
|
return "Set As Preempted";
|
|
case SANDBOX_PREEMPTED:
|
|
return "Preempted";
|
|
case SANDBOX_SET_AS_BLOCKED:
|
|
return "Set As Blocked";
|
|
case SANDBOX_BLOCKED:
|
|
return "Blocked";
|
|
case SANDBOX_SET_AS_RETURNED:
|
|
return "Set As Returned";
|
|
case SANDBOX_RETURNED:
|
|
return "Returned";
|
|
case SANDBOX_SET_AS_COMPLETE:
|
|
return "Set As Complete";
|
|
case SANDBOX_COMPLETE:
|
|
return "Complete";
|
|
case SANDBOX_SET_AS_ERROR:
|
|
return "Set As Error";
|
|
case SANDBOX_ERROR:
|
|
return "Error";
|
|
default:
|
|
/* Crash, as this should be exclusive */
|
|
assert(0);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Given a sandbox, returns the module that sandbox is executing
|
|
* @param sandbox the sandbox whose module we want
|
|
* @return the module of the provided sandbox
|
|
*/
|
|
static inline struct module *
|
|
sandbox_get_module(struct sandbox *sandbox)
|
|
{
|
|
if (!sandbox) return NULL;
|
|
return sandbox->module;
|
|
}
|
|
|
|
/**
|
|
* Getter for the arguments of the sandbox
|
|
* @param sandbox
|
|
* @return the arguments of the sandbox
|
|
*/
|
|
static inline char *
|
|
sandbox_get_arguments(struct sandbox *sandbox)
|
|
{
|
|
if (!sandbox) return NULL;
|
|
return (char *)sandbox->arguments;
|
|
}
|
|
|
|
/**
|
|
* Initializes and returns an IO handle on the current sandbox ready for use
|
|
* @param sandbox
|
|
* @return index of handle we preopened or -1 on error (sandbox is null or all io_handles are exhausted)
|
|
*/
|
|
static inline int
|
|
sandbox_initialize_io_handle(struct sandbox *sandbox)
|
|
{
|
|
if (!sandbox) return -1;
|
|
int io_handle_index;
|
|
for (io_handle_index = 0; io_handle_index < SANDBOX_MAX_IO_HANDLE_COUNT; io_handle_index++) {
|
|
if (sandbox->io_handles[io_handle_index].file_descriptor < 0) break;
|
|
}
|
|
if (io_handle_index == SANDBOX_MAX_IO_HANDLE_COUNT) return -1;
|
|
sandbox->io_handles[io_handle_index].file_descriptor = SANDBOX_FILE_DESCRIPTOR_PREOPEN_MAGIC;
|
|
memset(&sandbox->io_handles[io_handle_index].libuv_handle, 0, sizeof(union uv_any_handle));
|
|
return io_handle_index;
|
|
}
|
|
|
|
|
|
/**
|
|
* Initializes and returns an IO handle of a sandbox ready for use
|
|
* @param sandbox
|
|
* @param file_descriptor what we'll set on the IO handle after initialization
|
|
* @return index of handle we preopened or -1 if all io_handles are exhausted
|
|
*/
|
|
static inline int
|
|
sandbox_initialize_io_handle_and_set_file_descriptor(struct sandbox *sandbox, int file_descriptor)
|
|
{
|
|
if (!sandbox) return -1;
|
|
if (file_descriptor < 0) return file_descriptor;
|
|
int io_handle_index = sandbox_initialize_io_handle(sandbox);
|
|
if (io_handle_index != -1) {
|
|
sandbox->io_handles[io_handle_index].file_descriptor =
|
|
file_descriptor; /* per sandbox, so synchronization necessary! */
|
|
}
|
|
return io_handle_index;
|
|
}
|
|
|
|
/**
|
|
* Sets the file descriptor of the sandbox's ith io_handle
|
|
* Returns error condition if the file_descriptor to set does not contain sandbox preopen magic
|
|
* @param sandbox
|
|
* @param io_handle_index index of the sandbox io_handles we want to set
|
|
* @param file_descriptor the file descripter we want to set it to
|
|
* @returns the index that was set or -1 in case of error
|
|
*/
|
|
static inline int
|
|
sandbox_set_file_descriptor(struct sandbox *sandbox, int io_handle_index, int file_descriptor)
|
|
{
|
|
if (!sandbox) return -1;
|
|
if (io_handle_index >= SANDBOX_MAX_IO_HANDLE_COUNT || io_handle_index < 0) return -1;
|
|
if (file_descriptor < 0
|
|
|| sandbox->io_handles[io_handle_index].file_descriptor != SANDBOX_FILE_DESCRIPTOR_PREOPEN_MAGIC)
|
|
return -1;
|
|
sandbox->io_handles[io_handle_index].file_descriptor = file_descriptor;
|
|
return io_handle_index;
|
|
}
|
|
|
|
/**
|
|
* Get the file descriptor of the sandbox's ith io_handle
|
|
* @param sandbox
|
|
* @param io_handle_index index into the sandbox's io_handles table
|
|
* @returns file descriptor or -1 in case of error
|
|
*/
|
|
static inline int
|
|
sandbox_get_file_descriptor(struct sandbox *sandbox, int io_handle_index)
|
|
{
|
|
if (!sandbox) return -1;
|
|
if (io_handle_index >= SANDBOX_MAX_IO_HANDLE_COUNT || io_handle_index < 0) return -1;
|
|
return sandbox->io_handles[io_handle_index].file_descriptor;
|
|
}
|
|
|
|
/**
|
|
* Close the sandbox's ith io_handle
|
|
* @param sandbox
|
|
* @param io_handle_index index of the handle to close
|
|
*/
|
|
static inline void
|
|
sandbox_close_file_descriptor(struct sandbox *sandbox, int io_handle_index)
|
|
{
|
|
if (io_handle_index >= SANDBOX_MAX_IO_HANDLE_COUNT || io_handle_index < 0) return;
|
|
/* TODO: Do we actually need to call some sort of close function here? */
|
|
sandbox->io_handles[io_handle_index].file_descriptor = -1;
|
|
}
|
|
|
|
/**
|
|
* Get the Libuv handle located at idx of the sandbox ith io_handle
|
|
* @param sandbox
|
|
* @param io_handle_index index of the handle containing libuv_handle???
|
|
* @returns any libuv handle or a NULL pointer in case of error
|
|
*/
|
|
static inline union uv_any_handle *
|
|
sandbox_get_libuv_handle(struct sandbox *sandbox, int io_handle_index)
|
|
{
|
|
if (!sandbox) return NULL;
|
|
if (io_handle_index >= SANDBOX_MAX_IO_HANDLE_COUNT || io_handle_index < 0) return NULL;
|
|
return &sandbox->io_handles[io_handle_index].libuv_handle;
|
|
}
|
|
|
|
/**
|
|
* Prints key performance metrics for a sandbox to STDOUT
|
|
* @param sandbox
|
|
*/
|
|
static inline void
|
|
sandbox_print_perf(struct sandbox *sandbox)
|
|
{
|
|
uint64_t total_time_us = sandbox->total_time / runtime_processor_speed_MHz;
|
|
uint64_t queued_us = (sandbox->allocation_timestamp - sandbox->request_arrival_timestamp)
|
|
/ runtime_processor_speed_MHz;
|
|
uint64_t initializing_us = sandbox->initializing_duration / runtime_processor_speed_MHz;
|
|
uint64_t runnable_us = sandbox->runnable_duration / runtime_processor_speed_MHz;
|
|
uint64_t running_us = sandbox->running_duration / runtime_processor_speed_MHz;
|
|
uint64_t blocked_us = sandbox->blocked_duration / runtime_processor_speed_MHz;
|
|
uint64_t returned_us = sandbox->returned_duration / runtime_processor_speed_MHz;
|
|
debuglog("%lu, %s():%d, state: %s, deadline: %u, actual: %lu, queued: %lu, initializing: %lu, runnable: %lu, "
|
|
"running: "
|
|
"%lu, blocked: "
|
|
"%lu, returned %lu\n",
|
|
sandbox->request_arrival_timestamp, sandbox->module->name, sandbox->module->port,
|
|
sandbox_state_stringify(sandbox->state), sandbox->module->relative_deadline_us, total_time_us,
|
|
queued_us, initializing_us, runnable_us, running_us, blocked_us, returned_us);
|
|
}
|
|
|
|
void sandbox_set_as_initialized(struct sandbox *sandbox, struct sandbox_request *sandbox_request,
|
|
uint64_t allocation_timestamp) __attribute__((always_inline));
|
|
void sandbox_set_as_runnable(struct sandbox *sandbox, sandbox_state_t last_state) __attribute__((always_inline));
|
|
void sandbox_set_as_running(struct sandbox *sandbox, sandbox_state_t last_state) __attribute__((always_inline));
|
|
void sandbox_set_as_blocked(struct sandbox *sandbox, sandbox_state_t last_state) __attribute__((always_inline));
|
|
void sandbox_set_as_preempted(struct sandbox *sandbox, sandbox_state_t last_state) __attribute__((always_inline));
|
|
void sandbox_set_as_returned(struct sandbox *sandbox, sandbox_state_t last_state) __attribute__((always_inline));
|
|
void sandbox_set_as_complete(struct sandbox *sandbox, sandbox_state_t last_state) __attribute__((always_inline));
|
|
void sandbox_set_as_error(struct sandbox *sandbox, sandbox_state_t last_state) __attribute__((always_inline));
|