path: root/litmus/sched_ext_res.c

#include <linux/percpu.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/uaccess.h>

#include <litmus/sched_plugin.h>
#include <litmus/preempt.h>
#include <litmus/debug_trace.h>

#include <litmus/litmus.h>
#include <litmus/jobs.h>
#include <litmus/budget.h>
#include <litmus/rt_param.h>
#include <litmus/litmus_proc.h>
#include <litmus/sched_trace.h>
#include <litmus/feather_trace.h>

#include <litmus/reservations/ext_reservation.h>
#include <litmus/reservations/gedf_reservation.h>
#include <litmus/reservations/table_driven_ext_reservation.h>

struct mtd_reservation_environment* mtd_env;

struct cpu_time {
	struct hrtimer timer;
	lt_t last_update_time;
};

static DEFINE_PER_CPU(struct cpu_time, cpu_time);

static enum hrtimer_restart on_budget_timeout(struct hrtimer *timer)
{
	litmus_reschedule_local();
	return HRTIMER_NORESTART;
}

static struct task_struct* ext_res_schedule(struct task_struct * prev)
{
	int cpu = smp_processor_id();
	lt_t now, delta, time_slice;
	struct cpu_time* entry;
	struct task_struct* next;

	entry = this_cpu_ptr(&cpu_time);
	now = litmus_clock();
	delta = now - entry->last_update_time;
	time_slice = ULLONG_MAX;

	mtd_env->env.ops->update_time(&mtd_env->env, delta, cpu);
	next = mtd_env->env.ops->dispatch(&mtd_env->env, &time_slice, cpu);

	entry->last_update_time = now;

	if (time_slice != ULLONG_MAX) {
		hrtimer_start(&entry->timer,
			ns_to_ktime(entry->last_update_time + time_slice),
			HRTIMER_MODE_ABS_PINNED_HARD);
	} else
		hrtimer_try_to_cancel(&entry->timer);

	sched_state_task_picked();

	return next;
}

/* Called when a task should be removed from the ready queue.
 */
static void ext_res_task_block(struct task_struct *tsk)
{
	struct ext_reservation* res;

	TRACE_TASK(tsk, "thread suspends at %llu \n", litmus_clock());

	res = (struct ext_reservation*) tsk_rt(tsk)->plugin_state;
	res->par_env->ops->remove_res(res->par_env, res, 0, 0);
}


/* Called when the state of tsk changes back to TASK_RUNNING.
 * We need to requeue the task.
 */
static void ext_res_task_resume(struct task_struct  *tsk)
{
	struct ext_reservation* res;

	TRACE_TASK(tsk, "thread wakes up at %llu\n", litmus_clock());

	res = (struct ext_reservation*) tsk_rt(tsk)->plugin_state;
	res->par_env->ops->add_res(res->par_env, res, 0);
}

static long ext_res_admit_task(struct task_struct *tsk)
{
	long err = 0;

	struct gedf_task_reservation* gedf_task_res;
	struct mtd_reservation* mtd_res;

	mtd_res = container_of(
		mtd_env->env.ops->find_res_by_id(&mtd_env->env, tsk_rt(tsk)->task_params.cpu),
		struct mtd_reservation,
		res[0]);

	if (!mtd_res)
		return -EINVAL;

	/* allocate task reservation */
	err = alloc_gedf_task_reservation(&gedf_task_res, tsk);
	if (err)
		return err;
	tsk_rt(tsk)->plugin_state = gedf_task_res;

	gedf_task_res->gedf_res.res.par_env = mtd_res->res[0].env;
	gedf_task_res->gedf_res.pinned_cpu = tsk_rt(tsk)->task_params.pinned_cpu;

	return 0;
}

static void ext_res_task_new(struct task_struct *tsk, int on_runqueue,
			  int is_running)
{
	struct ext_reservation* res;
	lt_t now = litmus_clock();

	TRACE_TASK(tsk, "new RT task %llu (on_rq:%d, running:%d)\n",
		   now, on_runqueue, is_running);

	res = (struct ext_reservation*)tsk_rt(tsk)->plugin_state;

	release_at(tsk, now);
	res->replenishment_time = now;

	res->par_env->ops->add_res(res->par_env, res, 0);

	if (is_running)
		litmus_reschedule_local();
}

/*
static bool pres_fork_task(struct task_struct *tsk)
{
	TRACE_CUR("is forking\n");
	TRACE_TASK(tsk, "forked child rt:%d cpu:%d task_cpu:%d "
		        "wcet:%llu per:%llu\n",
		is_realtime(tsk),
		tsk_rt(tsk)->task_params.cpu,
		task_cpu(tsk),
		tsk_rt(tsk)->task_params.exec_cost,
		tsk_rt(tsk)->task_params.period);

	// We always allow forking.
	// The newly forked task will be in the same reservation.
	return true;
}
*/

static void ext_res_task_exit(struct task_struct *tsk)
{
	struct ext_reservation* res;
	struct ext_reservation_environment* par_env;

	res = (struct ext_reservation*)tsk_rt(tsk)->plugin_state;
	par_env = res->par_env;

	par_env->ops->remove_res(par_env, res, 1, 0);

	TRACE_TASK(tsk, "task exits at %llu \n", litmus_clock());
}

/* used by task budget tracking in budget.c. Since we have tasks in containers that track
 * budget, we don't need this. Furthermore, this scheme doesn't work efficiently with
 * multicore reservations
 */
/*
static void pres_current_budget(lt_t *used_so_far, lt_t *remaining)
{
	struct pres_task_state *tstate = get_pres_state(current);
	struct pres_cpu_state *state;

	// FIXME: protect against concurrent task_exit()

	local_irq_disable();

	state = cpu_state_for(tstate->cpu);

	raw_spin_lock(&state->lock);

	sup_update_time(&state->sup_env, litmus_clock());
	if (remaining)
		*remaining = tstate->client->reservation->cur_budget;
	if (used_so_far)
		*used_so_far = tstate->client->reservation->budget_consumed;
	pres_update_timer_and_unlock(state);

	local_irq_enable();
}
*/

static long do_ext_res_reservation_create(
	int res_type,
	struct reservation_config *config)
{
	struct ext_reservation* res;
	struct mtd_reservation* mtd_res;
	struct gedf_reservation_environment* gedf_env;
	long err;
	int i;

	if (res_type != TABLE_DRIVEN) {
		return -EINVAL;
	}

	res = mtd_env->env.ops->find_res_by_id(
			&mtd_env->env,
			config->id);

	if (!res) {
		/* allocate and init mtd_reservation */
		err = alloc_mtd_reservation(&mtd_res,
				config->id,
				config->table_driven_params.major_cycle_length);
		if (err)
			return err;

		/* allocate and init gedf_reservation_envrionment */
		err = alloc_gedf_reservation_environment(&gedf_env, num_online_cpus());
		if (err)
			return err;

		/* couple these two together */
		gedf_env->env.res = &mtd_res->res[0];
		for_each_online_cpu(i) {
			mtd_res->res[i].env = &gedf_env->env;
		}
	} else {
		mtd_res = container_of(res, struct mtd_reservation, res[0]);
	}

	err = mtd_res_install_table(
		mtd_res,
		config->table_driven_params.intervals,
		config->table_driven_params.major_cycle_length,
		config->table_driven_params.num_intervals,
		config->cpu);
	if (err)
		return err;

	mtd_env->env.ops->add_res(&mtd_env->env, &mtd_res->res[config->cpu], config->cpu);

	return err;
}

static long ext_res_reservation_create(int res_type, void* __user _config)
{
	struct reservation_config config;

	TRACE("Attempt to create reservation (%d)\n", res_type);

	if (copy_from_user(&config, _config, sizeof(config)))
		return -EFAULT;

	if (config.cpu < 0 || !cpu_online(config.cpu)) {
		printk(KERN_ERR "invalid polling reservation (%u): "
		       "CPU %d offline\n", config.id, config.cpu);
		return -EINVAL;
	}

	return do_ext_res_reservation_create(res_type, &config);
}

/*
static bool ext_res_should_wait_for_stack(struct task_struct* t) {
	int other = tsk_rt(t)->stack_in_use;
	struct gedf_reservation_environment* gedf_env =
		(struct gedf_reservation_environment*)mtd_env->cpu_entries[other]->linked->env;
	gedf_env->cpu_entries[other]->scheduled
	struct gedf_reservation* gedf_res = (struct gedf_reservation*)tsk_rt(t)->plugin_state;
	return gedf_res->linked_on && gedf_res->linked_on->scheduled == gedf_res;
}
*/


#ifdef CONFIG_LITMUS_LOCKING

/* **** lock constructor **** */

static long ext_res_allocate_lock(struct litmus_lock **lock, int type,
				 void* __user unused)
{
	struct ext_reservation_environment *gedf_env;
	int err = -ENXIO;

	/* pass the allocate_lock call to the task's component */
	gedf_env = ((struct ext_reservation*) tsk_rt(current)->plugin_state)->par_env;
	err = gedf_env->ops->allocate_lock(gedf_env, lock, type, unused);

	return err;
}

#endif


static struct domain_proc_info ext_res_domain_proc_info;

static long ext_res_get_domain_proc_info(struct domain_proc_info **ret)
{
	*ret = &ext_res_domain_proc_info;
	return 0;
}

static void ext_res_setup_domain_proc(void)
{
	int i, cpu;
	int num_rt_cpus = num_online_cpus();

	struct cd_mapping *cpu_map, *domain_map;

	memset(&ext_res_domain_proc_info, 0, sizeof(ext_res_domain_proc_info));
	init_domain_proc_info(&ext_res_domain_proc_info, num_rt_cpus, num_rt_cpus);
	ext_res_domain_proc_info.num_cpus = num_rt_cpus;
	ext_res_domain_proc_info.num_domains = num_rt_cpus;

	i = 0;
	for_each_online_cpu(cpu) {
		cpu_map = &ext_res_domain_proc_info.cpu_to_domains[i];
		domain_map = &ext_res_domain_proc_info.domain_to_cpus[i];

		cpu_map->id = cpu;
		domain_map->id = i;
		cpumask_set_cpu(i, cpu_map->mask);
		cpumask_set_cpu(cpu, domain_map->mask);
		++i;
	}
}

static long ext_res_activate_plugin(void)
{
	int cpu;
	int num_cpus = num_online_cpus();
	struct cpu_time* entry;

	alloc_mtd_reservation_environment(&mtd_env, num_cpus);

	for_each_online_cpu(cpu) {
		TRACE("Initializing CPU%d...\n", cpu);
		entry = per_cpu_ptr(&cpu_time, cpu);
		hrtimer_init(&entry->timer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS_HARD);
		entry->timer.function = on_budget_timeout;
		mtd_env->cpu_entries[cpu].id = cpu;
	}

	ft_enable_event(30);
	ft_enable_event(31);
	ft_enable_event(32);
	ft_enable_event(33);
	ft_enable_event(34);
	ft_enable_event(35);
	ft_enable_event(38);
	ft_enable_event(39);
	ft_enable_event(40);
	ft_enable_event(41);
	ft_enable_event(209);

	ext_res_setup_domain_proc();

	return 0;
}

static long ext_res_deactivate_plugin(void)
{
	int cpu;
	struct cpu_time* entry;

	for_each_online_cpu(cpu) {
		entry = per_cpu_ptr(&cpu_time, cpu);
		hrtimer_cancel(&entry->timer);
	}

	mtd_env->env.ops->shutdown(&mtd_env->env);

	ft_disable_event(30);
	ft_disable_event(31);
	ft_disable_event(32);
	ft_disable_event(33);
	ft_disable_event(34);
	ft_disable_event(35);
	ft_disable_event(38);
	ft_disable_event(39);
	ft_disable_event(40);
	ft_disable_event(41);
	ft_disable_event(209);

	destroy_domain_proc_info(&ext_res_domain_proc_info);
	return 0;
}

static struct sched_plugin ext_res_plugin = {
	.plugin_name		= "EXT-RES",
	.schedule		= ext_res_schedule,
	.task_block		= ext_res_task_block,
	.task_wake_up		= ext_res_task_resume,
	.admit_task		= ext_res_admit_task,
	.task_new		= ext_res_task_new,
	//.fork_task		= pres_fork_task,
	.task_exit		= ext_res_task_exit,
	.complete_job           = complete_job,
	.get_domain_proc_info   = ext_res_get_domain_proc_info,
	.activate_plugin	= ext_res_activate_plugin,
	.deactivate_plugin      = ext_res_deactivate_plugin,
	.reservation_create     = ext_res_reservation_create,
	//.current_budget         = pres_current_budget,
	//.should_wait_for_stack = ext_res_should_wait_for_stack,
#ifdef CONFIG_LITMUS_LOCKING
	.allocate_lock		= ext_res_allocate_lock,
#endif
};

static int __init init_ext_res(void)
{
	return register_sched_plugin(&ext_res_plugin);
}

module_init(init_ext_res);