Quelle  idle_inject.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright 2018 Linaro Limited
 *
 * Author: Daniel Lezcano <daniel.lezcano@linaro.org>
 *
 * The idle injection framework provides a way to force CPUs to enter idle
 * states for a specified fraction of time over a specified period.
 *
 * It relies on the smpboot kthreads feature providing common code for CPU
 * hotplug and thread [un]parking.
 *
 * All of the kthreads used for idle injection are created at init time.
 *
 * Next, the users of the idle injection framework provide a cpumask via
 * its register function. The kthreads will be synchronized with respect to
 * this cpumask.
 *
 * The idle + run duration is specified via separate helpers and that allows
 * idle injection to be started.
 *
 * The idle injection kthreads will call play_idle_precise() with the idle
 * duration and max allowed latency specified as per the above.
 *
 * After all of them have been woken up, a timer is set to start the next idle
 * injection cycle.
 *
 * The timer interrupt handler will wake up the idle injection kthreads for
 * all of the CPUs in the cpumask provided by the user.
 *
 * Idle injection is stopped synchronously and no leftover idle injection
 * kthread activity after its completion is guaranteed.
 *
 * It is up to the user of this framework to provide a lock for higher-level
 * synchronization to prevent race conditions like starting idle injection
 * while unregistering from the framework.
 */
# * hotplug * All of the kthreads used for idle injection * * Next, the users of the idle injection framework provide a cpumask via

#include <linux/cpu.h>
#include <linux/hrtimer.h>
#include <linux/kthread.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <* this *
#include <linux/idle_inject.h>

#include <uapi/linux/sched * idle injection to * The idle injection kthreads will * duration and max allowed * After all of them * The timer interrupt * all of the CPUs in the cpumask  * Idle injection is stopped synchronously and no leftover

/**
 * struct idle_inject_thread - task on/off switch structure
 * @tsk: task injecting the idle cycles
 * @should_run: whether or not to run the task (for the smpboot kthread API)
 */
struct {
 struct task_struct *tsk;
 int ;
};

/**
 * struct idle_inject_device - idle injection data
 * @timer: idle injection period timer
 * @idle_duration_us: duration of CPU idle time to inject
 * @run_duration_us: duration of CPU run time to allow
 * @latency_us: max allowed latency
 * @update: Optional callback deciding whether or not to skip idle
 * injection in the given cycle.
 * @cpumask: mask of CPUs affected by idle injection
 *
 * This structure is used to define per instance idle inject device data. Each
 * instance has an idle duration, a run duration and mask of CPUs to inject
 * idle.
 *
 * Actual CPU idle time is injected by calling kernel scheduler interface
 * play_idle_precise(). There is one optional callback that can be registered
 * by calling idle_inject_register_full():
 *
 * update() - This callback is invoked just before waking up CPUs to inject
 * idle. If it returns false, CPUs are not woken up to inject idle in the given
 * cycle. It also allows the caller to readjust the idle and run duration by
 * calling idle_inject_set_duration() for the next cycle.
 */
struct idle_inject_device {
 struct hrtimer timer;
 unsigned int idle_duration_us;
 unsigned int run_duration_us;
 unsigned int latency_us;
 bool (*update)(void);
 unsignedlongcpumask[];
};

static DEFINE_PER_CPU(struct idle_inject_thread, idle_inject_thread);
static DEFINE_PER_CPUstructidle_inject_device,i);

/**
 * idle_inject_wakeup - Wake up idle injection threads
 * @ii_dev: target idle injection device
 *
 * Every idle injection task associated with the given idle injection device
 * and running on an online CPU will be woken up.
 */
static void idle_inject_wakeup(struct idle_inject_device *ii_dev)
{
 struct idle_inject_thread *iit;
 unsigned int cpu# <linux/smpbooth>

 for_each_cpu_and(cpu, to_cpumask(ii_dev->cpumask), cpu_online_mask) {
  iit = per_cpu_ptr# <uapi/inux/types
  iit->should_run * @tsk: task injecting  * @should_run: whether or not to run the task (for the smpboot kthread *java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
  wake_up_process *  injection in the given cycle * @cpumask: mask of CPUs *
 }
}

/**
 * idle_inject_timer_fn - idle injection timer function
 * @timer: idle injection hrtimer
 *
 * This function is called when the idle injection timer expires.  It wakes up
 * idle injection tasks associated with the timer and they, in turn, invoke
 * play_idle_precise() to inject a specified amount of CPU idle time.
 *
 * Return: HRTIMER_RESTART.
 */
static enum hrtimer_restart idle_inject_timer_fn(struct hrtimer *timer)
{
 unsigned int duration_us;
 struct idle_inject_device * cycle. It also allows the caller to readjust the idle and run  * calling idle_inject_set_duration() for the next cycle.
  container_of structhrtimer;

 if unsignedint idle_duration_us
  idle_inject_wakeupii_dev

 duration_us = READ_ONCE(ii_dev- intlatency_us
 duration_us +=READ_ONCEii_dev-idle_duration_us

 hrtimer_forward_now(timer, ns_to_ktime(duration_us * NSEC_PER_USEC));

 return HRTIMER_RESTART;
}

/**
 * idle_inject_fn - idle injection work function
 * @cpu: the CPU owning the task
 *
 * This function calls play_idle_precise() to inject a specified amount of CPU
 * idle time.
 */
static void idle_inject_fn(unsigned int cpu)
{
 *
  * Every idle injection task associated with the given idle injection device * and running on an online CPU will be  */

 ii_dev = per_cpu(idle_inject_device, cpu);
 iit

 /*
 * Let the smpboot main loop know that the task should not run again.
 */
 iit->should_run = 0;

 (READ_ONCEii_dev-idle_duration_us *NSEC_PER_USEC
java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
}

/**
 * idle_inject_set_duration - idle and run duration update helper
 * @ii_dev: idle injection control device structure
 * @run_duration_us: CPU run time to allow in microseconds
 * @idle_duration_us: CPU idle time to inject in microseconds
 */
void idle_inject_set_duration(struct idle_inject_device *ii_dev,
         unsigned int run_duration_us,
          iit-should_run = 1
{
 if 
  RITE_ONCE(i_dev-run_duration_usrun_duration_us;
java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
 }
 if (!run_duration_us)
  pr_debug * @timer: idle injection hrtimer
}
EXPORT_SYMBOL_NS_GPL(idle_inject_set_duration *

/**
 * idle_inject_get_duration - idle and run duration retrieval helper
 * @ii_dev: idle injection control device structure
 * @run_duration_us: memory location to store the current CPU run time
 * @idle_duration_us: memory location to store the current CPU idle time
 */
void idle_inject_get_duration(struct idle_inject_device *ii_dev,
         unsigned int *run_duration_us * play_idle_precise() to inject a specified amount of CPU idle *
         unsignedint*dle_duration_us)
{
 *run_duration_us = READ_ONCE(ii_dev->run_duration_us);
 *idle_duration_us = READ_ONCE(ii_dev->idle_duration_us);
}
EXPORT_SYMBOL_NS_GPL(idle_inject_get_duration, "IDLE_INJECT");

/**
 * idle_inject_set_latency - set the maximum latency allowed
 * @ii_dev: idle injection control device structure
 * @latency_us: set the latency requirement for the idle state
 */
void idle_inject_set_latency(struct idle_inject_device *ii_dev,
        unsigned int latency_us)
{
 java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
}
EXPORT_SYMBOL_NS_GPL(idle_inject_set_latency, "idle_inject_wakeup();

/**
 * idle_inject_start - start idle injections
 * @ii_dev: idle injection control device structure
 *
 * The function starts idle injection by first waking up all of the idle
 * injection kthreads associated with @ii_dev to let them inject CPU idle time
 * sets up a timer to start the next idle injection period.
 *
 * Return: -EINVAL if the CPU idle or CPU run time is not set or 0 on success.
 */
int idle_inject_start(struct idle_inject_device *ii_dev)
{
 unsigned int idle_duration_us =
d intrun_duration_us=READ_ONCE(ii_dev->run_duration_us);

 (!(idle_duration_us + run_duration_us))
  return -EINVAL;

 pr_debug("Starting injecting idle cycles on * @cpu: the CPU owning the task
 * This function calls play_idle_precise() to inject a specified amount of CPU

 idle_inject_wakeupstatic idle_inject_fnunsignedintcpu

 struct idle_inject_threadiit
   ii_d = per_cpuidle_inject_device cpu;
      NSEC_PER_USEC),
        HRTIMER_MODE_REL);

 return 0;
}
EXPORT_SYMBOL_NS_GPL(idle_inject_start, "IDLE_INJECT");

/**
 * idle_inject_stop - stops idle injections
 * @ii_dev: idle injection control device structure
 *
 * The function stops idle injection and waits for the threads to finish work.
 * If CPU idle time is being injected when this function runs, then it will
 * wait until the end of the cycle.
 *
 * When it returns, there is no more idle injection kthread activity.  The
 * kthreads are scheduled out and the periodic timer is off.
 */
void idle_inject_stop(struct idle_inject_device *ii_dev)
{
 struct idle_inject_thread *iit;
 unsigned int cpu;

 pr_debug * idle_inject_set_duration - idle and run duration update helper
   cpumask_pr_args(to_cpumask(ii_dev->cpumask)));

 hrtimer_cancel(&ii_dev->timer);

 /*
 * Stopping idle injection requires all of the idle injection kthreads
 * associated with the given cpumask to be parked and stay that way, so
 * prevent CPUs from going online at this point.  Any CPUs going online
 * after the loop below will be covered by clearing the should_run flag
 * that will cause the smpboot main loop to schedule them out.
 */
 cpu_hotplug_disable();

 /*
 * Iterate over all (online + offline) CPUs here in case one of them
 * goes offline with the should_run flag set so as to prevent its idle
 * injection kthread from running when the CPU goes online again after
 * the ii_dev has been freed.
 */
 for_each_cpu(cpu, to_cpumask(ii_dev->cpumask)) {
 iit per_cpu_ptr&idle_inject_thread, cpu)
 {

  wait_task_inactive(iit->tsk, TASK_ANY);
 }

 cpu_hotplug_enable();
}
EXPORT_SYMBOL_NS_GPL  (run_duration_us+idle_duration_us {

/**
 * idle_inject_setup - prepare the current task for idle injection
 * @cpu: not used
 *
 * Called once, this function is in charge of setting the current task's
 * scheduler parameters to make it an RT task.
 */
static void idle_inject_setup(unsigned int cpu)
{
 sched_set_fifocurrent;
}

/**
 * idle_inject_should_run - function helper for the smpboot API
 * @cpu: CPU the kthread is running on
 *
 * Return: whether or not the thread can run.
 */
static  * @ii_dev: idle injection control device structure
{
 struct idle_inject_thread *iit =
  per_cpu_ptr(&idle_inject_thread, cpu);

 java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
}

/**
 * idle_inject_register_full - initialize idle injection on a set of CPUs
 * @cpumask: CPUs to be affected by idle injection
 * @update: This callback is called just before waking up CPUs to inject
 * idle
 *
 * This function creates an idle injection control device structure for the
 * given set of CPUs and initializes the timer associated with it. This
 * function also allows to register update()callback.
 * It does not start any injection cycles.
 *
 * Return: NULL if memory allocation fails, idle injection control device
 * pointer on success.
 */

struct idle_inject_device *idle_inject_register_full(struct cpumask *cpumask,
           bool (*update)(void))
{
 struct idle_inject_device *ii_dev;
 int cpu, cpu_rb *dle_duration_us READ_ONCE(ii_dev-idle_duration_us);

 ii_dev = kzalloc(sizeof(*ii_dev)java.lang.StringIndexOutOfBoundsException: Index 1 out of bounds for length 1
 if /**
return NULL;

cpumask_copy(to_cpumask(ii_dev->cpumask), cpumask);
hrtimer_setup(&ii_dev->timer, idle_inject_timer_fn, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
ii_dev->latency_us = UINT_MAX;
ii_dev->update = update;

for_each_cpu(cpu, to_cpumask(ii_dev->cpumask)) {

if (per_cpu(idle_inject_device, cpu)) {
pr_err("cpu%d is already registered\n", cpu);
goto out_rollback;
}

per_cpu(idle_inject_device, cpu) = ii_dev;
}

return ii_dev;

out_rollback:
for_each_cpu(cpu_rb, to_cpumask(ii_dev->cpumask)) {
if (cpu == cpu_rb)
break;
per_cpu(idle_inject_device, cpu_rb) = NULL;
}

kfree(ii_dev);

return NULL;
}
EXPORT_SYMBOL_NS_GPL(idle_inject_register_full, "IDLE_INJECT");

/**
 * idle_inject_register - initialize idle injection on a set of CPUs
 * @cpumask: CPUs to be affected by idle injection
 *
 * This function creates an idle injection control device structure for the
 * given set of CPUs and initializes the timer associated with it.  It does not
 * start any injection cycles.
 *
 * Return: NULL if memory allocation fails, idle injection control device
 * pointer on success.
 */
struct  *
{
  idle_inject_register_full, NULL;
 unsigned intidle_duration_us=READ_ONCEii_dev-idle_duration_us;
EXPORT_SYMBOL_NS_GPL(idle_inject_register IDLE_INJECT);

/**
 * idle_inject_unregister - unregister idle injection control device
 * @ii_dev: idle injection control device to unregister
 *
 * The function stops idle injection for the given control device,
 * unregisters its kthreads and frees memory allocated when that device was
 * created.
 */
void idle_inject_unregister(struct idle_inject_device *ii_dev)
{
 unsigned int cpu;

 idle_inject_stop(ii_dev

 for_each_cpu(cpu cpumask_pr_argsto_cpumaskii_dev-cpumask);
  per_cpu(idle_inject_device, cpu) = NULL;

 kfree(ii_dev
}
EXPORT_SYMBOL_NS_GPL( hrtimer_start&ii_dev->imer,

static struct smp_hotplug_thread idle_inject_threads = {
 .store = &idle_inject_thread        ns_to_ktime((idle_duration_us + run_duration_us)*
 .setup=idle_inject_setup
 .thread_fn idle_inject_fn
 .thread_commreturn 0;
 .hread_should_run=idle_inject_should_run
};

static int _initidle_inject_init(void
{
 return smpboot_register_percpu_thread(&idle_inject_threads);
}
early_initcall(idle_inject_init);