dsched_fq - Refactor fqp allocation/destruction
[dragonfly.git] / sys / dsched / fq / dsched_fq.h
1 /*
2  * Copyright (c) 2009, 2010 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Alex Hornung <ahornung@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 #ifndef _DSCHED_FQ_H_
35 #define _DSCHED_FQ_H_
36
37 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
38
39 #ifndef _SYS_QUEUE_H_
40 #include <sys/queue.h>
41 #endif
42 #ifndef _SYS_BIO_H_
43 #include <sys/bio.h>
44 #endif
45 #ifndef _SYS_BIOTRACK_H_
46 #include <sys/biotrack.h>
47 #endif
48 #ifndef _SYS_SPINLOCK_H_
49 #include <sys/spinlock.h>
50 #endif
51 /*
52 #define FQ_IOQ_INIT(x)          lockinit(&(x)->fq_lock, "fqioq", 0, LK_CANRECURSE)
53 #define FQ_IOQ_LOCK(x)          lockmgr(&(x)->fq_lock, LK_EXCLUSIVE)
54 #define FQ_IOQ_UNLOCK(x)        lockmgr(&(x)->fq_lock, LK_RELEASE)
55 */
56
57 #define FQ_FQMP_LOCKINIT(x)     spin_init(&(x)->lock)
58 #define FQ_FQP_LOCKINIT(x)      spin_init(&(x)->lock)
59 #define FQ_DPRIV_LOCKINIT(x)    spin_init(&(x)->lock)
60 #define FQ_GLOBAL_FQMP_LOCKINIT(x)      spin_init(&fq_fqmp_lock)
61
62
63 #define FQ_FQMP_LOCK(x)         fq_reference_mpriv((x)); \
64                                 spin_lock_wr(&(x)->lock)
65
66 #define FQ_FQP_LOCK(x)          fq_reference_priv((x)); \
67                                 spin_lock_wr(&(x)->lock)
68
69 #define FQ_DPRIV_LOCK(x)        fq_reference_dpriv((x)); \
70                                 spin_lock_wr(&(x)->lock)
71
72 #define FQ_GLOBAL_FQMP_LOCK(x)  spin_lock_wr(&fq_fqmp_lock)
73
74
75 #define FQ_FQMP_UNLOCK(x)       spin_unlock_wr(&(x)->lock); \
76                                 fq_dereference_mpriv((x))
77
78 #define FQ_FQP_UNLOCK(x)        spin_unlock_wr(&(x)->lock); \
79                                 fq_dereference_priv((x))
80
81 #define FQ_DPRIV_UNLOCK(x)      spin_unlock_wr(&(x)->lock); \
82                                 fq_dereference_dpriv((x))
83
84 #define FQ_GLOBAL_FQMP_UNLOCK(x) spin_unlock_wr(&fq_fqmp_lock)
85
86 #define FQ_REBALANCE_TIMEOUT    1       /* in seconds */
87 #define FQ_TOTAL_DISK_TIME      1000000*FQ_REBALANCE_TIMEOUT    /* in useconds */
88
89 #define FQ_PRIO_BIAS            5
90 #define FQ_PRIO_MAX             10
91 #define FQ_PRIO_MIN             1
92 #define FQ_PRIO_IDLE            -1
93 #define FQ_BUCKET_ACTIVE        0x01
94
95 #define FQ_DRAIN_CANCEL 0x1
96 #define FQ_DRAIN_FLUSH  0x2
97
98 struct disk;
99 struct proc;
100
101 #define FQP_LINKED_DPRIV        0x01
102 #define FQP_LINKED_FQMP         0x02
103
104 struct dsched_fq_priv {
105         TAILQ_ENTRY(dsched_fq_priv)     link;
106         TAILQ_ENTRY(dsched_fq_priv)     dlink;
107         TAILQ_HEAD(, bio)       queue;
108
109         struct  spinlock        lock;
110         struct  disk            *dp;
111         struct dsched_fq_dpriv  *dpriv;
112         struct dsched_fq_mpriv  *fqmp;
113         struct proc             *p;
114
115         int32_t qlength;
116         int32_t flags;
117
118         int     refcount;
119         int32_t transactions;
120         int32_t avg_latency;
121         int32_t s_transactions;
122         int32_t s_avg_latency;
123         int32_t max_tp;
124         int32_t issued;
125
126         int     rebalance;
127 };
128
129 struct dsched_fq_dpriv {
130         struct thread   *td;
131         struct thread   *td_balance;
132         struct disk     *dp;
133         struct spinlock lock;
134         int     refcount;
135
136         int     avg_rq_time;    /* XXX: unused */
137         int32_t incomplete_tp;
138         int64_t max_budget;
139         int     idle;
140         struct timeval start_idle;
141         int     idle_time;
142         int     die;
143
144         int     prev_full;
145         int     last_full;
146         int     disk_busy;
147         int64_t budgetpb[FQ_PRIO_MAX+1];
148
149         /* list contains all fq_priv for this disk */
150         TAILQ_HEAD(, dsched_fq_priv)    fq_priv_list;
151         TAILQ_ENTRY(dsched_fq_dpriv)    link;
152 };
153
154 struct dsched_fq_mpriv {
155         struct proc *p;
156         struct thread *td;
157         int dead;
158         struct spinlock lock;
159         int     refcount;
160         TAILQ_HEAD(, dsched_fq_priv)    fq_priv_list;
161         TAILQ_ENTRY(dsched_fq_mpriv)    link;
162 };
163
164
165
166
167
168 struct dsched_fq_priv   *fq_alloc_priv(struct disk *dp, struct dsched_fq_mpriv *fqmp);
169 struct dsched_fq_dpriv  *fq_alloc_dpriv(struct disk *dp);
170 struct dsched_fq_mpriv  *fq_alloc_mpriv(struct proc *p);
171 void    fq_balance_thread(struct dsched_fq_dpriv *dpriv);
172 void    fq_dispatcher(struct dsched_fq_dpriv *dpriv);
173 biodone_t       fq_completed;
174
175 void    fq_reference_dpriv(struct dsched_fq_dpriv *dpriv);
176 void    fq_reference_priv(struct dsched_fq_priv *fqp);
177 void    fq_reference_mpriv(struct dsched_fq_mpriv *fqmp);
178 void    fq_dereference_dpriv(struct dsched_fq_dpriv *dpriv);
179 void    fq_dereference_priv(struct dsched_fq_priv *fqp);
180 void    fq_dereference_mpriv(struct dsched_fq_mpriv *fqmp);
181 void    fq_dispatch(struct dsched_fq_dpriv *dpriv, struct bio *bio,
182                         struct dsched_fq_priv *fqp);
183 void    fq_drain(struct dsched_fq_dpriv *dpriv, int mode);
184 void    fq_balance_self(struct dsched_fq_priv *fqp);
185 #endif /* _KERNEL || _KERNEL_STRUCTURES */
186
187
188 struct dsched_fq_stats {
189         int32_t fqmp_allocations;
190         int32_t fqp_allocations;
191         int32_t dpriv_allocations;
192
193         int32_t procs_limited;
194
195         int32_t transactions;
196         int32_t transactions_completed;
197         int32_t cancelled;
198
199         int32_t no_fqmp;
200
201         int32_t nthreads;
202         int32_t nprocs;
203
204         int32_t nbufs;
205 };
206
207 #endif /* _DSCHED_FQ_H_ */