wait_for_completion_killable函数功能描述:此函数用于阻塞当前进程,等待其他进程的执行结束,被等待进程保存在输入参数的wait字段所代表的等待队列中。有两种情况可以结束此种等待,第一,当等待队列中的进程被函数complete( )或函数complete_all( )唤醒,结束等待;第二,强制结束等待,通过Ctrl+C强制结束这个等待。
此函数将当前进程设置为可杀死的状态,可以通过Ctrl+C强制进程的执行结束,此状态的详细定义解释参考函数__wake_up( )的分析文档中的进程状态说明部分;此函数设置的等待时间是MAX_SCHEDULE_TIMEOUT个系统时钟节拍,这是一个很长的时间,几乎无法因等待超时而唤醒进程,使进程执行结束。
wait_for_completion_killable文件包含
#include <linux/completion.h>
wait_for_completion_killable函数定义
在内核源码中的位置:linux-3.19.3/kernel/sched/completion.c
函数定义格式:
int __sched wait_for_completion_killable(struct completion *x)
wait_for_completion_killable输入参数说明
此函数的输入参数是struct completion结构体类型的指针,包含一个等待队列信息及等待队列的状态信息,等待队列的状态代表此等待队列是否被唤醒过,其定义及详细解释参考函数complete( )分析文档的输入参数说明部分。
wait_for_completion_killable返回参数说明
此函数的返回结果是int型的变量,代表等待者结束的情况,可能的取值是0或-512。返回-512说明等待是被强制终止的,即通过Ctrl+C或者kill命令结束的;返回0说明等待是正常执行结束的,即通过函数complete( )或函数complete_all( )唤醒等待进程结束等待状态。
wait_for_completion_killable实例解析
编写测试文件:wait_for_completion_killable.c
头文件引用及全局变量定义:
/*头文件引用*/
#include <linux/module.h>
#include <linux/sched.h>
#include <linux/pid.h>
#include <linux/wait.h>
#include <linux/completion.h>
#include <linux/kthread.h>
MODULE_LICENSE("GPL");
/*全局变量定义*/
static struct completion comple; //用于保存completion的状态
static struct task_struct * old_thread; //保存初始化进程的信息
子进程处理函数定义:
int my_function(void * argc)
{
wait_queue_head_t head;
wait_queue_t data;
printk("in the kernel thread function! \n");
init_waitqueue_head(&head); //初始化等待队列头元素
init_waitqueue_entry(&data, current); // 用当前进程初始化等待队列元素
add_wait_queue(&head, &data); //将当前进程插入到等待队列中
schedule_timeout_uninterruptible(10); // 将等待队列置于不可中断的等待状态
printk("the current pid is:%d\n", current->pid); //显示当前进程的PID值
printk("the state of the real_parent is:%ld\n", old_thread->state);
//显示父进程的状态
//complete(&comple); //调用函数唤醒进程,并更改done字段的值
printk("out the kernel thread function\n");
return 0;
}
模块加载函数定义:
static int __init wait_for_completion_killable_init(void)
{
struct task_struct * result;
long leavetime;
wait_queue_t data;
printk("into wait_for_completion_killable_init.\n");
old_thread = current;
result=kthread_create_on_node(my_function, NULL, -1, "wait_for_completion_killable");
// 创建新进程
wake_up_process(result);
/*获取新进程的描述符信息*/
init_completion(&comple); //初始化completion变量
init_waitqueue_entry(&data, result); //用新进程初始化等待队列元素
__add_wait_queue_tail(&(comple.wait), &data); //将新进程加入等待队列的尾部
leavetime=wait_for_completion_killable(&comple); //阻塞进程,等待新进程的结束
/*显示函数wait_for_completion_killable( )的返回结果*/
printk("the result of the wait_for_completion_killable is:%ld\n", leavetime);
/*显示函数kernel_thread( )的返回结果*/
printk("the pid of new thread is :%d\n", result->pid);
printk("the current pid is:%d\n", current->pid); //显示当前进程的PID值
printk("out wait_for_completion_killable_init.\n");
return 0;
}
C
模块退出函数定义:
static void __exit wait_for_completion_killable_exit(void)
{
printk("Goodbye wait_for_completion_killable\n");
}
模块加载、退出函数调用:
module_init(wait_for_completion_killable_init);
module_exit(wait_for_completion_killable_exit);
实例运行结果及分析:
首先编译模块,执行命令insmod wait_for_completion_killable.ko插入内核模块,此时终端会停止,不能回到命令行模式,通过Ctrl+C组合键强制终止程序,然后输入命令dmesg -c会出现如图A
所示的结果。
去掉在子进程中对语句“complete(&comple); ”
的注释,保存文件,重新编译、加载模块,此时不会出现图A
所出现的情况,程序会很快执行结束,然后输入命令dmesg -c会出现如图B
所示的结果。
结果分析:
从图A
和图B
可以看出在子进程执行时父进程的状态值都是130,即父进程处于可杀死的等待状态,并且子进程都在父进程之前执行完毕,父进程会等待子进程的执行完毕。
图A
中显示函数wait_for_completion_killable( )的返回结果是-512,可以推测此等待是被强制终止的,实际情况也是如此。
图B
中显示函数wait_for_completion_killable( )的返回结果是0,可以推测此等待是正常结束的,实际情况是通过调用函数complete( )结束的,调用函数complete( )可以迅速的结束函数wait_for_completion_killable( )中的循环,所以不会出现图A
所示程序执行无法自动结束的情况。
说明
对于子进程处理函数中调用函数schedule_timeout_uninterruptible( )使子进程进入短暂的睡眠,是为了保证父进程中的函数wait_for_completion_killable( )能够在子进程中显示父进程状态之前被执行,从而能看到函数wait_for_completion_killable( )对当前进程的作用。
进程状态说明:
对于进程能够处于的状态,在函数__wake_up( )的进程状态说明部分有详细的说明。