2009-01-07 09:45:46 -07:00
|
|
|
/*
|
|
|
|
* async.c: Asynchronous function calls for boot performance
|
|
|
|
*
|
|
|
|
* (C) Copyright 2009 Intel Corporation
|
|
|
|
* Author: Arjan van de Ven <arjan@linux.intel.com>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; version 2
|
|
|
|
* of the License.
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
|
|
|
Goals and Theory of Operation
|
|
|
|
|
|
|
|
The primary goal of this feature is to reduce the kernel boot time,
|
|
|
|
by doing various independent hardware delays and discovery operations
|
|
|
|
decoupled and not strictly serialized.
|
|
|
|
|
|
|
|
More specifically, the asynchronous function call concept allows
|
|
|
|
certain operations (primarily during system boot) to happen
|
|
|
|
asynchronously, out of order, while these operations still
|
|
|
|
have their externally visible parts happen sequentially and in-order.
|
|
|
|
(not unlike how out-of-order CPUs retire their instructions in order)
|
|
|
|
|
|
|
|
Key to the asynchronous function call implementation is the concept of
|
|
|
|
a "sequence cookie" (which, although it has an abstracted type, can be
|
|
|
|
thought of as a monotonically incrementing number).
|
|
|
|
|
|
|
|
The async core will assign each scheduled event such a sequence cookie and
|
|
|
|
pass this to the called functions.
|
|
|
|
|
|
|
|
The asynchronously called function should before doing a globally visible
|
|
|
|
operation, such as registering device numbers, call the
|
|
|
|
async_synchronize_cookie() function and pass in its own cookie. The
|
|
|
|
async_synchronize_cookie() function will make sure that all asynchronous
|
|
|
|
operations that were scheduled prior to the operation corresponding with the
|
|
|
|
cookie have completed.
|
|
|
|
|
|
|
|
Subsystem/driver initialization code that scheduled asynchronous probe
|
|
|
|
functions, but which shares global resources with other drivers/subsystems
|
|
|
|
that do not use the asynchronous call feature, need to do a full
|
|
|
|
synchronization with the async_synchronize_full() function, before returning
|
|
|
|
from their init function. This is to maintain strict ordering between the
|
|
|
|
asynchronous and synchronous parts of the kernel.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <linux/async.h>
|
2011-05-31 12:51:55 -07:00
|
|
|
#include <linux/atomic.h>
|
|
|
|
#include <linux/ktime.h>
|
2011-05-23 11:51:41 -07:00
|
|
|
#include <linux/export.h>
|
2009-01-07 09:45:46 -07:00
|
|
|
#include <linux/wait.h>
|
|
|
|
#include <linux/sched.h>
|
include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h
percpu.h is included by sched.h and module.h and thus ends up being
included when building most .c files. percpu.h includes slab.h which
in turn includes gfp.h making everything defined by the two files
universally available and complicating inclusion dependencies.
percpu.h -> slab.h dependency is about to be removed. Prepare for
this change by updating users of gfp and slab facilities include those
headers directly instead of assuming availability. As this conversion
needs to touch large number of source files, the following script is
used as the basis of conversion.
http://userweb.kernel.org/~tj/misc/slabh-sweep.py
The script does the followings.
* Scan files for gfp and slab usages and update includes such that
only the necessary includes are there. ie. if only gfp is used,
gfp.h, if slab is used, slab.h.
* When the script inserts a new include, it looks at the include
blocks and try to put the new include such that its order conforms
to its surrounding. It's put in the include block which contains
core kernel includes, in the same order that the rest are ordered -
alphabetical, Christmas tree, rev-Xmas-tree or at the end if there
doesn't seem to be any matching order.
* If the script can't find a place to put a new include (mostly
because the file doesn't have fitting include block), it prints out
an error message indicating which .h file needs to be added to the
file.
The conversion was done in the following steps.
1. The initial automatic conversion of all .c files updated slightly
over 4000 files, deleting around 700 includes and adding ~480 gfp.h
and ~3000 slab.h inclusions. The script emitted errors for ~400
files.
2. Each error was manually checked. Some didn't need the inclusion,
some needed manual addition while adding it to implementation .h or
embedding .c file was more appropriate for others. This step added
inclusions to around 150 files.
3. The script was run again and the output was compared to the edits
from #2 to make sure no file was left behind.
4. Several build tests were done and a couple of problems were fixed.
e.g. lib/decompress_*.c used malloc/free() wrappers around slab
APIs requiring slab.h to be added manually.
5. The script was run on all .h files but without automatically
editing them as sprinkling gfp.h and slab.h inclusions around .h
files could easily lead to inclusion dependency hell. Most gfp.h
inclusion directives were ignored as stuff from gfp.h was usually
wildly available and often used in preprocessor macros. Each
slab.h inclusion directive was examined and added manually as
necessary.
6. percpu.h was updated not to include slab.h.
7. Build test were done on the following configurations and failures
were fixed. CONFIG_GCOV_KERNEL was turned off for all tests (as my
distributed build env didn't work with gcov compiles) and a few
more options had to be turned off depending on archs to make things
build (like ipr on powerpc/64 which failed due to missing writeq).
* x86 and x86_64 UP and SMP allmodconfig and a custom test config.
* powerpc and powerpc64 SMP allmodconfig
* sparc and sparc64 SMP allmodconfig
* ia64 SMP allmodconfig
* s390 SMP allmodconfig
* alpha SMP allmodconfig
* um on x86_64 SMP allmodconfig
8. percpu.h modifications were reverted so that it could be applied as
a separate patch and serve as bisection point.
Given the fact that I had only a couple of failures from tests on step
6, I'm fairly confident about the coverage of this conversion patch.
If there is a breakage, it's likely to be something in one of the arch
headers which should be easily discoverable easily on most builds of
the specific arch.
Signed-off-by: Tejun Heo <tj@kernel.org>
Guess-its-ok-by: Christoph Lameter <cl@linux-foundation.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Lee Schermerhorn <Lee.Schermerhorn@hp.com>
2010-03-24 01:04:11 -07:00
|
|
|
#include <linux/slab.h>
|
2010-07-02 01:03:52 -07:00
|
|
|
#include <linux/workqueue.h>
|
2009-01-07 09:45:46 -07:00
|
|
|
|
|
|
|
static async_cookie_t next_cookie = 1;
|
|
|
|
|
|
|
|
#define MAX_WORK 32768
|
|
|
|
|
|
|
|
static LIST_HEAD(async_pending);
|
|
|
|
static LIST_HEAD(async_running);
|
|
|
|
static DEFINE_SPINLOCK(async_lock);
|
|
|
|
|
|
|
|
struct async_entry {
|
2010-07-02 01:03:52 -07:00
|
|
|
struct list_head list;
|
|
|
|
struct work_struct work;
|
|
|
|
async_cookie_t cookie;
|
|
|
|
async_func_ptr *func;
|
|
|
|
void *data;
|
|
|
|
struct list_head *running;
|
2009-01-07 09:45:46 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
static DECLARE_WAIT_QUEUE_HEAD(async_done);
|
|
|
|
|
|
|
|
static atomic_t entry_count;
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* MUST be called with the lock held!
|
|
|
|
*/
|
|
|
|
static async_cookie_t __lowest_in_progress(struct list_head *running)
|
|
|
|
{
|
|
|
|
struct async_entry *entry;
|
2009-05-24 13:03:43 -07:00
|
|
|
|
2009-01-11 08:35:01 -07:00
|
|
|
if (!list_empty(running)) {
|
|
|
|
entry = list_first_entry(running,
|
2009-01-07 09:45:46 -07:00
|
|
|
struct async_entry, list);
|
2009-06-08 12:31:53 -07:00
|
|
|
return entry->cookie;
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
|
|
|
|
2009-06-08 12:31:53 -07:00
|
|
|
list_for_each_entry(entry, &async_pending, list)
|
|
|
|
if (entry->running == running)
|
|
|
|
return entry->cookie;
|
2009-05-24 13:03:43 -07:00
|
|
|
|
2009-06-08 12:31:53 -07:00
|
|
|
return next_cookie; /* "infinity" value */
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
2009-01-11 08:35:01 -07:00
|
|
|
|
|
|
|
static async_cookie_t lowest_in_progress(struct list_head *running)
|
|
|
|
{
|
|
|
|
unsigned long flags;
|
|
|
|
async_cookie_t ret;
|
|
|
|
|
|
|
|
spin_lock_irqsave(&async_lock, flags);
|
|
|
|
ret = __lowest_in_progress(running);
|
|
|
|
spin_unlock_irqrestore(&async_lock, flags);
|
|
|
|
return ret;
|
|
|
|
}
|
2010-07-02 01:03:52 -07:00
|
|
|
|
2009-01-07 09:45:46 -07:00
|
|
|
/*
|
|
|
|
* pick the first pending entry and run it
|
|
|
|
*/
|
2010-07-02 01:03:52 -07:00
|
|
|
static void async_run_entry_fn(struct work_struct *work)
|
2009-01-07 09:45:46 -07:00
|
|
|
{
|
2010-07-02 01:03:52 -07:00
|
|
|
struct async_entry *entry =
|
|
|
|
container_of(work, struct async_entry, work);
|
2009-01-07 09:45:46 -07:00
|
|
|
unsigned long flags;
|
2011-07-07 04:10:40 -07:00
|
|
|
ktime_t uninitialized_var(calltime), delta, rettime;
|
2009-01-07 09:45:46 -07:00
|
|
|
|
2010-07-02 01:03:52 -07:00
|
|
|
/* 1) move self to the running queue */
|
2009-01-07 09:45:46 -07:00
|
|
|
spin_lock_irqsave(&async_lock, flags);
|
2009-02-02 05:24:34 -07:00
|
|
|
list_move_tail(&entry->list, entry->running);
|
2009-01-07 09:45:46 -07:00
|
|
|
spin_unlock_irqrestore(&async_lock, flags);
|
|
|
|
|
2010-07-02 01:03:52 -07:00
|
|
|
/* 2) run (and print duration) */
|
2009-01-07 10:28:53 -07:00
|
|
|
if (initcall_debug && system_state == SYSTEM_BOOTING) {
|
2011-05-31 12:51:55 -07:00
|
|
|
printk(KERN_DEBUG "calling %lli_%pF @ %i\n",
|
|
|
|
(long long)entry->cookie,
|
2009-02-04 16:11:58 -07:00
|
|
|
entry->func, task_pid_nr(current));
|
2009-01-07 09:45:46 -07:00
|
|
|
calltime = ktime_get();
|
|
|
|
}
|
|
|
|
entry->func(entry->data, entry->cookie);
|
2009-01-07 10:28:53 -07:00
|
|
|
if (initcall_debug && system_state == SYSTEM_BOOTING) {
|
2009-01-07 09:45:46 -07:00
|
|
|
rettime = ktime_get();
|
|
|
|
delta = ktime_sub(rettime, calltime);
|
2011-05-31 12:51:55 -07:00
|
|
|
printk(KERN_DEBUG "initcall %lli_%pF returned 0 after %lld usecs\n",
|
2009-02-04 16:11:58 -07:00
|
|
|
(long long)entry->cookie,
|
|
|
|
entry->func,
|
|
|
|
(long long)ktime_to_ns(delta) >> 10);
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
|
|
|
|
2010-07-02 01:03:52 -07:00
|
|
|
/* 3) remove self from the running queue */
|
2009-01-07 09:45:46 -07:00
|
|
|
spin_lock_irqsave(&async_lock, flags);
|
|
|
|
list_del(&entry->list);
|
|
|
|
|
2010-07-02 01:03:52 -07:00
|
|
|
/* 4) free the entry */
|
2009-01-07 09:45:46 -07:00
|
|
|
kfree(entry);
|
|
|
|
atomic_dec(&entry_count);
|
|
|
|
|
|
|
|
spin_unlock_irqrestore(&async_lock, flags);
|
|
|
|
|
2010-07-02 01:03:52 -07:00
|
|
|
/* 5) wake up any waiters */
|
2009-01-07 09:45:46 -07:00
|
|
|
wake_up(&async_done);
|
|
|
|
}
|
|
|
|
|
|
|
|
static async_cookie_t __async_schedule(async_func_ptr *ptr, void *data, struct list_head *running)
|
|
|
|
{
|
|
|
|
struct async_entry *entry;
|
|
|
|
unsigned long flags;
|
|
|
|
async_cookie_t newcookie;
|
|
|
|
|
|
|
|
/* allow irq-off callers */
|
|
|
|
entry = kzalloc(sizeof(struct async_entry), GFP_ATOMIC);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* If we're out of memory or if there's too much work
|
|
|
|
* pending already, we execute synchronously.
|
|
|
|
*/
|
2010-07-02 01:03:52 -07:00
|
|
|
if (!entry || atomic_read(&entry_count) > MAX_WORK) {
|
2009-01-07 09:45:46 -07:00
|
|
|
kfree(entry);
|
|
|
|
spin_lock_irqsave(&async_lock, flags);
|
|
|
|
newcookie = next_cookie++;
|
|
|
|
spin_unlock_irqrestore(&async_lock, flags);
|
|
|
|
|
|
|
|
/* low on memory.. run synchronously */
|
|
|
|
ptr(data, newcookie);
|
|
|
|
return newcookie;
|
|
|
|
}
|
2010-07-02 01:03:52 -07:00
|
|
|
INIT_WORK(&entry->work, async_run_entry_fn);
|
2009-01-07 09:45:46 -07:00
|
|
|
entry->func = ptr;
|
|
|
|
entry->data = data;
|
|
|
|
entry->running = running;
|
|
|
|
|
|
|
|
spin_lock_irqsave(&async_lock, flags);
|
|
|
|
newcookie = entry->cookie = next_cookie++;
|
|
|
|
list_add_tail(&entry->list, &async_pending);
|
|
|
|
atomic_inc(&entry_count);
|
|
|
|
spin_unlock_irqrestore(&async_lock, flags);
|
2010-07-02 01:03:52 -07:00
|
|
|
|
|
|
|
/* schedule for execution */
|
|
|
|
queue_work(system_unbound_wq, &entry->work);
|
|
|
|
|
2009-01-07 09:45:46 -07:00
|
|
|
return newcookie;
|
|
|
|
}
|
|
|
|
|
2009-01-19 05:45:33 -07:00
|
|
|
/**
|
|
|
|
* async_schedule - schedule a function for asynchronous execution
|
|
|
|
* @ptr: function to execute asynchronously
|
|
|
|
* @data: data pointer to pass to the function
|
|
|
|
*
|
|
|
|
* Returns an async_cookie_t that may be used for checkpointing later.
|
|
|
|
* Note: This function may be called from atomic or non-atomic contexts.
|
|
|
|
*/
|
2009-01-07 09:45:46 -07:00
|
|
|
async_cookie_t async_schedule(async_func_ptr *ptr, void *data)
|
|
|
|
{
|
2009-01-19 05:45:28 -07:00
|
|
|
return __async_schedule(ptr, data, &async_running);
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
|
|
|
EXPORT_SYMBOL_GPL(async_schedule);
|
|
|
|
|
2009-01-19 05:45:33 -07:00
|
|
|
/**
|
2009-01-20 07:31:31 -07:00
|
|
|
* async_schedule_domain - schedule a function for asynchronous execution within a certain domain
|
2009-01-19 05:45:33 -07:00
|
|
|
* @ptr: function to execute asynchronously
|
|
|
|
* @data: data pointer to pass to the function
|
2009-01-20 07:31:31 -07:00
|
|
|
* @running: running list for the domain
|
2009-01-19 05:45:33 -07:00
|
|
|
*
|
|
|
|
* Returns an async_cookie_t that may be used for checkpointing later.
|
2009-01-20 07:31:31 -07:00
|
|
|
* @running may be used in the async_synchronize_*_domain() functions
|
|
|
|
* to wait within a certain synchronization domain rather than globally.
|
|
|
|
* A synchronization domain is specified via the running queue @running to use.
|
2009-01-19 05:45:33 -07:00
|
|
|
* Note: This function may be called from atomic or non-atomic contexts.
|
|
|
|
*/
|
2009-01-20 07:31:31 -07:00
|
|
|
async_cookie_t async_schedule_domain(async_func_ptr *ptr, void *data,
|
|
|
|
struct list_head *running)
|
2009-01-07 09:45:46 -07:00
|
|
|
{
|
|
|
|
return __async_schedule(ptr, data, running);
|
|
|
|
}
|
2009-01-20 07:31:31 -07:00
|
|
|
EXPORT_SYMBOL_GPL(async_schedule_domain);
|
2009-01-07 09:45:46 -07:00
|
|
|
|
2009-01-19 05:45:33 -07:00
|
|
|
/**
|
|
|
|
* async_synchronize_full - synchronize all asynchronous function calls
|
|
|
|
*
|
|
|
|
* This function waits until all asynchronous function calls have been done.
|
|
|
|
*/
|
2009-01-07 09:45:46 -07:00
|
|
|
void async_synchronize_full(void)
|
|
|
|
{
|
2009-01-08 13:35:11 -07:00
|
|
|
do {
|
|
|
|
async_synchronize_cookie(next_cookie);
|
|
|
|
} while (!list_empty(&async_running) || !list_empty(&async_pending));
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
|
|
|
EXPORT_SYMBOL_GPL(async_synchronize_full);
|
|
|
|
|
2009-01-19 05:45:33 -07:00
|
|
|
/**
|
2009-01-20 07:31:31 -07:00
|
|
|
* async_synchronize_full_domain - synchronize all asynchronous function within a certain domain
|
2009-01-19 05:45:33 -07:00
|
|
|
* @list: running list to synchronize on
|
|
|
|
*
|
2009-01-20 07:31:31 -07:00
|
|
|
* This function waits until all asynchronous function calls for the
|
|
|
|
* synchronization domain specified by the running list @list have been done.
|
2009-01-19 05:45:33 -07:00
|
|
|
*/
|
2009-01-20 07:31:31 -07:00
|
|
|
void async_synchronize_full_domain(struct list_head *list)
|
2009-01-07 09:45:46 -07:00
|
|
|
{
|
2009-01-20 07:31:31 -07:00
|
|
|
async_synchronize_cookie_domain(next_cookie, list);
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
2009-01-20 07:31:31 -07:00
|
|
|
EXPORT_SYMBOL_GPL(async_synchronize_full_domain);
|
2009-01-07 09:45:46 -07:00
|
|
|
|
2009-01-19 05:45:33 -07:00
|
|
|
/**
|
2009-01-20 07:31:31 -07:00
|
|
|
* async_synchronize_cookie_domain - synchronize asynchronous function calls within a certain domain with cookie checkpointing
|
2009-01-19 05:45:33 -07:00
|
|
|
* @cookie: async_cookie_t to use as checkpoint
|
|
|
|
* @running: running list to synchronize on
|
|
|
|
*
|
2009-01-20 07:31:31 -07:00
|
|
|
* This function waits until all asynchronous function calls for the
|
|
|
|
* synchronization domain specified by the running list @list submitted
|
|
|
|
* prior to @cookie have been done.
|
2009-01-19 05:45:33 -07:00
|
|
|
*/
|
2009-01-20 07:31:31 -07:00
|
|
|
void async_synchronize_cookie_domain(async_cookie_t cookie,
|
|
|
|
struct list_head *running)
|
2009-01-07 09:45:46 -07:00
|
|
|
{
|
2011-07-07 04:10:40 -07:00
|
|
|
ktime_t uninitialized_var(starttime), delta, endtime;
|
2009-01-07 09:45:46 -07:00
|
|
|
|
2009-01-07 10:28:53 -07:00
|
|
|
if (initcall_debug && system_state == SYSTEM_BOOTING) {
|
2011-05-31 12:51:55 -07:00
|
|
|
printk(KERN_DEBUG "async_waiting @ %i\n", task_pid_nr(current));
|
2009-01-07 09:45:46 -07:00
|
|
|
starttime = ktime_get();
|
|
|
|
}
|
|
|
|
|
2009-01-11 08:35:01 -07:00
|
|
|
wait_event(async_done, lowest_in_progress(running) >= cookie);
|
2009-01-07 09:45:46 -07:00
|
|
|
|
2009-01-07 10:28:53 -07:00
|
|
|
if (initcall_debug && system_state == SYSTEM_BOOTING) {
|
2009-01-07 09:45:46 -07:00
|
|
|
endtime = ktime_get();
|
|
|
|
delta = ktime_sub(endtime, starttime);
|
|
|
|
|
2011-05-31 12:51:55 -07:00
|
|
|
printk(KERN_DEBUG "async_continuing @ %i after %lli usec\n",
|
2009-02-04 16:11:58 -07:00
|
|
|
task_pid_nr(current),
|
|
|
|
(long long)ktime_to_ns(delta) >> 10);
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
|
|
|
}
|
2009-01-20 07:31:31 -07:00
|
|
|
EXPORT_SYMBOL_GPL(async_synchronize_cookie_domain);
|
2009-01-07 09:45:46 -07:00
|
|
|
|
2009-01-19 05:45:33 -07:00
|
|
|
/**
|
|
|
|
* async_synchronize_cookie - synchronize asynchronous function calls with cookie checkpointing
|
|
|
|
* @cookie: async_cookie_t to use as checkpoint
|
|
|
|
*
|
|
|
|
* This function waits until all asynchronous function calls prior to @cookie
|
|
|
|
* have been done.
|
|
|
|
*/
|
2009-01-07 09:45:46 -07:00
|
|
|
void async_synchronize_cookie(async_cookie_t cookie)
|
|
|
|
{
|
2009-01-20 07:31:31 -07:00
|
|
|
async_synchronize_cookie_domain(cookie, &async_running);
|
2009-01-07 09:45:46 -07:00
|
|
|
}
|
|
|
|
EXPORT_SYMBOL_GPL(async_synchronize_cookie);
|