2 * Copyright (c) 2015 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Tomohiro Kusumi <kusumi.tomohiro@gmail.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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
35 #include <sys/types.h>
37 #include <sys/vnode.h>
38 #include <sys/mutex2.h>
39 #include <sys/objcache.h>
40 #include <sys/callout.h>
42 #include <dev/disk/dm/dm.h>
44 MALLOC_DEFINE(M_DMDELAY, "dm_delay", "Device Mapper Target Delay");
47 TAILQ_ENTRY(dm_delay_buf) entry;
51 TAILQ_HEAD(dm_delay_buf_list, dm_delay_buf);
53 struct dm_delay_info {
59 struct dm_delay_buf_list buf_list;
63 struct lwkt_token token;
67 typedef struct target_delay_config {
68 struct dm_delay_info read;
69 struct dm_delay_info write;
70 int argc; /* either 3 or 6 */
71 } dm_target_delay_config_t;
73 static int _init(struct dm_delay_info *di, char **argv, int id);
74 static int _status(struct dm_delay_info *di, char *p);
75 static void _strategy(struct dm_delay_info *di, struct buf *bp);
76 static void _submit(struct dm_delay_info *di, struct buf *bp);
77 static void _submit_queue(struct dm_delay_info *di, int submit_all);
78 static void _destroy(struct dm_delay_info *di);
79 static uint64_t _makeudev(struct dm_delay_info *di);
80 static void _timeout(void *arg);
81 static void _thread(void *arg);
82 static __inline void _debug(struct dm_delay_info *di, const char *msg);
84 static struct objcache *obj_cache = NULL;
85 static struct objcache_malloc_args obj_args = {
86 sizeof(struct dm_delay_buf), M_DMDELAY,
90 dm_target_delay_init(dm_dev_t *dmv, void **target_config, char *params)
92 dm_target_delay_config_t *tdc;
100 for (ap = argv; ap < &argv[6] &&
101 (*ap = strsep(¶ms, " \t")) != NULL;) {
107 aprint_debug("Delay target init: argc=%d\n", argc);
108 if (argc != 3 && argc != 6) {
109 kprintf("Delay target takes 3 or 6 args\n");
113 tdc = kmalloc(sizeof(*tdc), M_DMDELAY, M_WAITOK | M_ZERO);
117 ret = _init(&tdc->read, ap, 0);
119 kfree(tdc, M_DMDELAY);
126 ret = _init(&tdc->write, ap, 1);
128 dm_pdev_decr(tdc->read.pdev);
129 kfree(tdc, M_DMDELAY);
133 *target_config = tdc;
134 dmv->dev_type = DM_DELAY_DEV;
140 _init(struct dm_delay_info *di, char **argv, int id)
147 if ((dmp = dm_pdev_insert(argv[0])) == NULL)
151 di->offset = atoi64(argv[1]);
152 tmp = atoi64(argv[2]);
153 di->delay = tmp * hz / 1000;
156 TAILQ_INIT(&di->buf_list);
157 callout_init(&di->cal);
158 mtx_init(&di->buf_mtx, "dmdlbuf");
159 mtx_init(&di->cal_mtx, "dmdlcal");
160 lwkt_token_init(&di->token, "dmdlthr");
163 lwkt_create(_thread, di, &di->td, NULL, 0, -1, "dmdl%d", id);
170 dm_target_delay_status(void *target_config)
172 dm_target_delay_config_t *tdc;
176 KKASSERT(tdc != NULL);
178 params = kmalloc(DM_MAX_PARAMS_SIZE, M_DM, M_WAITOK);
180 p += _status(&tdc->read, p);
181 if (tdc->argc == 6) {
182 p += ksnprintf(p, DM_MAX_PARAMS_SIZE, " ");
183 _status(&tdc->write, p);
189 static int _status(struct dm_delay_info *di, char *p)
193 ret += ksnprintf(p, DM_MAX_PARAMS_SIZE,
195 di->pdev->name, di->offset, di->delay);
200 dm_target_delay_strategy(dm_table_entry_t *table_en, struct buf *bp)
202 dm_target_delay_config_t *tdc;
203 struct dm_delay_info *di;
205 tdc = table_en->target_config;
206 KKASSERT(tdc != NULL);
229 struct vnode *vnode = tdc->write.pdev->pdev_vnode;
230 vn_strategy(vnode, &bp->b_bio1);
236 _strategy(struct dm_delay_info *di, struct buf *bp)
238 struct dm_delay_buf *dp;
240 dp = objcache_get(obj_cache, M_WAITOK);
242 dp->expire = ticks + di->delay;
244 mtx_lock(&di->buf_mtx);
246 TAILQ_INSERT_TAIL(&di->buf_list, dp, entry);
247 mtx_unlock(&di->buf_mtx);
249 mtx_lock(&di->cal_mtx);
250 if (!callout_pending(&di->cal))
251 callout_reset(&di->cal, di->delay, _timeout, di);
252 mtx_unlock(&di->cal_mtx);
256 _submit(struct dm_delay_info *di, struct buf *bp)
258 _debug(di, "submit");
260 bp->b_bio1.bio_offset += di->offset * DEV_BSIZE;
261 vn_strategy(di->pdev->pdev_vnode, &bp->b_bio1);
265 _submit_queue(struct dm_delay_info *di, int submit_all)
267 struct dm_delay_buf *dp;
268 struct dm_delay_buf_list tmp_list;
272 _debug(di, "submitq");
273 TAILQ_INIT(&tmp_list);
275 mtx_lock(&di->buf_mtx);
276 while ((dp = TAILQ_FIRST(&di->buf_list)) != NULL) {
277 if (submit_all || ticks > dp->expire) {
278 TAILQ_REMOVE(&di->buf_list, dp, entry);
279 TAILQ_INSERT_TAIL(&tmp_list, dp, entry);
287 next = min(next, dp->expire);
290 mtx_unlock(&di->buf_mtx);
293 mtx_lock(&di->cal_mtx);
294 callout_reset(&di->cal, next - ticks, _timeout, di);
295 mtx_unlock(&di->cal_mtx);
298 while ((dp = TAILQ_FIRST(&tmp_list)) != NULL) {
299 TAILQ_REMOVE(&tmp_list, dp, entry);
301 objcache_put(obj_cache, dp);
306 dm_target_delay_destroy(dm_table_entry_t *table_en)
308 dm_target_delay_config_t *tdc;
310 tdc = table_en->target_config;
314 _destroy(&tdc->read);
315 _destroy(&tdc->write);
317 kfree(tdc, M_DMDELAY);
318 table_en->target_config = NULL;
324 _destroy(struct dm_delay_info *di)
326 _debug(di, "destroy");
328 lwkt_gettoken(&di->token);
331 mtx_lock(&di->cal_mtx);
332 if (callout_pending(&di->cal))
333 callout_stop_sync(&di->cal);
334 mtx_unlock(&di->cal_mtx);
336 _submit_queue(di, 1);
338 tsleep(&di->enabled, 0, "dmdldestroy", 0);
339 lwkt_reltoken(&di->token);
341 mtx_uninit(&di->cal_mtx);
342 mtx_uninit(&di->buf_mtx);
344 dm_pdev_decr(di->pdev);
348 dm_target_delay_deps(dm_table_entry_t *table_en, prop_array_t prop_array)
350 dm_target_delay_config_t *tdc;
353 tdc = table_en->target_config;
357 u1 = _makeudev(&tdc->read);
358 u2 = _makeudev(&tdc->write);
360 prop_array_add_uint64(prop_array, u1);
362 prop_array_add_uint64(prop_array, u2);
368 _makeudev(struct dm_delay_info *di)
374 _debug(di, "makeudev");
376 error = VOP_GETATTR(di->pdev->pdev_vnode, &va);
377 KKASSERT(error == 0);
379 ret = makeudev(va.va_rmajor, va.va_rminor);
380 return (uint64_t)ret;
384 dm_target_delay_upcall(dm_table_entry_t *table_en, struct buf *bp)
392 struct dm_delay_info *di = arg;
394 _debug(di, "timeout");
401 struct dm_delay_info *di = arg;
403 _debug(di, "thread init");
404 lwkt_gettoken(&di->token);
406 while (di->enabled) {
407 tsleep(di, 0, "dmdlthread", 0);
408 _submit_queue(di, 0);
412 wakeup(&di->enabled);
414 _debug(di, "thread exit");
415 lwkt_reltoken(&di->token);
421 _debug(struct dm_delay_info *di, const char *msg)
423 aprint_debug("%-8s: %d pdev=%s offset=%ju delay=%d count=%d\n",
424 msg, di->enabled, di->pdev->name,
425 (uintmax_t)di->offset, di->delay, di->count);
429 _objcache_create(void)
431 if (obj_cache == NULL) {
432 obj_cache = objcache_create("dmdlobj", 0, 0, NULL, NULL, NULL,
433 objcache_malloc_alloc,
434 objcache_malloc_free,
441 _objcache_destroy(void)
444 objcache_destroy(obj_cache);
450 dmtd_mod_handler(module_t mod, int type, void *unused)
452 dm_target_t *dmt = NULL;
457 if ((dmt = dm_target_lookup("delay")) != NULL) {
458 dm_target_unbusy(dmt);
461 dmt = dm_target_alloc("delay");
465 strlcpy(dmt->name, "delay", DM_MAX_TYPE_NAME);
466 dmt->init = &dm_target_delay_init;
467 dmt->status = &dm_target_delay_status;
468 dmt->strategy = &dm_target_delay_strategy;
469 dmt->destroy = &dm_target_delay_destroy;
470 dmt->deps = &dm_target_delay_deps;
471 dmt->upcall = &dm_target_delay_upcall;
475 err = dm_target_insert(dmt);
477 kprintf("dm_target_delay: Successfully initialized\n");
481 err = dm_target_rem("delay");
483 kprintf("dm_target_delay: unloaded\n");
491 DM_TARGET_MODULE(dm_target_delay, dmtd_mod_handler);