dsched_bfq - A budget fair-queuing dsched policy
[dragonfly.git] / sys / kern / dsched / bfq / bfq_helper_thread.h
1 /*
2  * Copyright (c) 2011 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Brills Peng <brillsp@gmail.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35
36 #ifndef _DSCHED_BFQ_HELPER_THREAD_H_
37 #define _DSCHED_BFQ_HELPER_THREAD_H_
38 #include <kern/dsched/bfq/bfq.h>
39
40 typedef struct helper_msg {
41         struct lwkt_msg hdr;
42         struct bfq_disk_ctx *bfq_diskctx;
43         struct dsched_thread_io *tdio;
44 } *helper_msg_t;
45
46 enum helper_msg_cmd {
47         BFQ_MSG_DEQUEUE = 1,
48         BFQ_MSG_AS_TIMEOUT,
49         BFQ_MSG_DESTROY_TDIO,
50         BFQ_MSG_KILL
51 };
52
53 void helper_init_global(void);
54 void helper_init(struct bfq_disk_ctx *bfq_diskctx);
55 void helper_uninit(struct bfq_disk_ctx *bfq_diskctx);
56 void helper_msg_dequeue(struct bfq_disk_ctx *bfq_diskctx);
57 void helper_msg_as_timeout(struct bfq_disk_ctx *bfq_diskctx);
58 void helper_msg_destroy_tdio(struct bfq_disk_ctx *bfq_diskctx, struct dsched_thread_io *tdio);
59 void helper_msg_kill(struct bfq_disk_ctx *bfq_diskctx);
60
61 #endif
62